Enum oas_core::Reference

pub enum Reference<T>where
    T: Clone,{
    Id(String),
    Resolved(TypedRecord<T>),
}

A reference is an enum that can be in two states: It either holds an ID to a record, or a loaded record.

Variants

Id(String)

Resolved(TypedRecord<T>)

Implementations

impl<T> Reference<T>where
    T: TypedValue,

pub fn id(&self) -> &str

Get the target id of the reference.

pub fn guid(&self) -> &str

pub fn record(&self) -> Option<&TypedRecord<T>>

Get the loaded record if the reference is resolved.

pub fn record_mut(&mut self) -> Option<&mut TypedRecord<T>>

Get a mutable reference to the loaded record if the reference is resolved.

pub fn into_record(self) -> Option<TypedRecord<T>>

Get the loaded record if the reference is resolved, while consuming the reference.

pub fn extract_record(&mut self) -> Option<TypedRecord<T>>

Extract the loaded record if the reference is resolved, while converting the reference to only hold an id.

pub fn resolved(&self) -> bool

Check if the reference is resolved and contains a loaded record.

pub async fn resolve<R>(
    &mut self,
    resolver: &R
) -> impl Future<Output = Result<(), ResolveError>>where
    R: Resolver,

Resolve this reference with a Resolver if the reference is not yet in the resolved state.

The Resolver trait is implemented on data stores.

pub async fn force_resolve<R>(
    &mut self,
    resolver: &R
) -> impl Future<Output = Result<(), ResolveError>>where
    R: Resolver,

Resolve the record, even if the reference is already in the resolved state.

pub async fn into_resolved<R>(
    self,
    resolver: &R
) -> impl Future<Output = Result<Reference<T>, ResolveError>>where
    R: Resolver,

Resolve the record while consuming self, and return a new reference in the resolved state.

pub fn set_resolved(&mut self, record: TypedRecord<T>)

Set the record to the resolved state while passing in the target record.

Trait Implementations

impl<T> Clone for Reference<T>where
    T: Clone,

fn clone(&self) -> Reference<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Reference<T>where
    T: Debug + Clone,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Reference<T>where
    T: Clone + Deserialize<'de>,

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Reference<T>, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<ResolveError> for Reference<T>where
    T: TypedValue,

fn from(err: ResolveError) -> Reference<T>

Converts to this type from the input type.

impl<T> JsonSchema for Reference<T>where
    T: Clone + JsonSchema,

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T> Serialize for Reference<T>where
    T: Clone + Serialize,

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.