Struct surrealml_core::storage::header::origin::Origin

pub struct Origin {
    pub origin: OriginValue,
    pub author: StringValue,
}

Defines the origin of the model in the file header.

Fields

• origin - The origin of the model.
• author - The author of the model.

Fields

origin: OriginValue

author: StringValue

Implementations

impl Origin

pub fn fresh() -> Self

Creates a new origin with no values.

Returns

A new origin with no values.

pub fn add_author(&mut self, author: String)

Adds an author to the origin struct.

Arguments

• origin - The origin to be added.

pub fn add_origin(&mut self, origin: String) -> Result<(), SurrealError>

Adds an origin to the origin struct.

Arguments

pub fn to_string(&self) -> String

Converts an origin to a string.

Returns

The origin as a string.

pub fn from_string(origin: String) -> Result<Self, SurrealError>

Creates a new origin from a string.

Arguments

• origin - The origin as a string.

Returns

A new origin.

Trait Implementations

impl Debug for Origin

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

Formats the value using the given formatter.

impl PartialEq for Origin

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Origin