Struct ORef 

pub struct ORef {
    pub otype: String,
    pub oid: String,
}

Object reference combining a type name and UUID. Wire format: "block:550e8400-e29b-41d4-a716-446655440000"

#[ts(type = "string")] is load-bearing, not decoration. This struct has a hand-written Serialize/Deserialize pair (below) that emits and parses a single "otype:oid" STRING — the Rust shape and the wire shape deliberately disagree. Without this attribute ts-rs would faithfully generate { otype: string, oid: string } from the struct, which is not what any client ever receives: it would be a confidently wrong binding, worse than none, and the compiler could not catch it because TypeScript would simply believe it. ts-rs documents this attribute for exactly this case — “when you have a custom serializer and deserializer”.

Fields

otype: String

oid: String

Implementations

impl ORef

pub fn new(otype: impl Into<String>, oid: impl Into<String>) -> Self

pub fn is_empty(&self) -> bool

pub fn parse(s: &str) -> Result<Self, ORefParseError>

Parse an ORef from the “otype:oid” string format.

Trait Implementations

impl Clone for ORef

fn clone(&self) -> ORef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ORef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ORef

fn default() -> ORef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ORef

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ORef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ORef

impl Hash for ORef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ORef

fn eq(&self, other: &ORef) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ORef

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ORef

impl TS for ORef

type WithoutGenerics = ORef

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ORef

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn name(_: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(_: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn decl(_: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn decl_concrete(_: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn visit_dependencies(_: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn visit_generics(_: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use [TS::export].

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.