Skip to main content

DefinitionRead

mars_schema::read

Struct DefinitionRead

pub struct DefinitionRead<T> {
    pub frontmatter: Vec<(String, OrderedValue)>,
    pub fields: Option<T>,
    pub body: Option<String>,
    pub diagnostics: Vec<SchemaDiagnostic>,
}

Fields§

§frontmatter: Vec<(String, OrderedValue)>

Ordered top-level mapping, retaining unknown authored keys.

§fields: Option<T>§body: Option<String>§diagnostics: Vec<SchemaDiagnostic>

Implementations§

impl<T> DefinitionRead<T>

pub fn into_fields(self) -> Result<T, String>

The typed fields, or why there are none: the frontmatter cannot be parsed at all.

pub fn into_valid(self) -> Result<Valid<T>, SchemaDiagnostic>

What a caller that acts on the file needs: the fields, the body and the warnings that came with them, or the first error. A file with any error is refused whole.

Trait Implementations§

impl<T: Clone> Clone for DefinitionRead<T>

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for DefinitionRead<T>

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

Formats the value using the given formatter. Read more

impl<T> Serialize for DefinitionRead<T>
where T: Serialize,

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl<T> Forget for DefinitionRead<T>

impl<T> Freeze for DefinitionRead<T>
where Option<T>: Freeze,

impl<T> RefUnwindSafe for DefinitionRead<T>
where Option<T>: RefUnwindSafe,

impl<T> Send for DefinitionRead<T>
where Option<T>: Send,

impl<T> Sync for DefinitionRead<T>
where Option<T>: Sync,

impl<T> Unpin for DefinitionRead<T>
where Option<T>: Unpin,

impl<T> UnsafeUnpin for DefinitionRead<T>
where Option<T>: UnsafeUnpin,

impl<T> UnwindSafe for DefinitionRead<T>
where Option<T>: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.