Skip to main content

RootSchema

Struct RootSchema 

Source
pub struct RootSchema {
    pub meta_schema: Option<String>,
    pub schema: YamlSchema,
    pub base_uri: Option<Url>,
}
Expand description

A RootSchema represents the root document in a schema document, and includes additional fields such as $schema that are not allowed in subschemas. It also provides a way to resolve references to other schemas.

Fields§

§meta_schema: Option<String>§schema: YamlSchema§base_uri: Option<Url>

Base URI for resolving relative $ref values (from file path, URL, or $id).

Implementations§

Source§

impl RootSchema

Source

pub fn empty() -> Self

Create an empty RootSchema

Source

pub fn new(schema: YamlSchema) -> Self

Create a new RootSchema with a given schema

Source

pub fn id(&self) -> Option<String>

Returns the $id of the schema’s Subschema, if present.

Source

pub fn cache_key(&self, fallback: &str) -> String

Returns the preferred key for caching this schema: $id if it is a valid URI, otherwise the given fallback (e.g. the file or fetch URI).

Source

pub fn resolve(&self, pointer: &Pointer) -> Option<&YamlSchema>

Resolve a JSON Pointer to an element in the schema.

Trait Implementations§

Source§

impl Debug for RootSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RootSchema

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'r> TryFrom<&MarkedYaml<'r>> for RootSchema

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(marked_yaml: &MarkedYaml<'r>) -> Result<Self>

Performs the conversion.
Source§

impl Validator for RootSchema

Source§

fn validate(&self, context: &Context<'_>, value: &MarkedYaml<'_>) -> Result<()>

Source§

impl StructuralPartialEq for RootSchema

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more