Struct Fragment

pub struct Fragment<N>(pub BTreeMap<Option<Name>, NamespaceDefinition<N>>);

A Fragment is split into multiple namespace definitions, and is just a map from namespace name to namespace definition (i.e., definitions of common types, entity types, and actions in that namespace). The namespace name is implicitly applied to all definitions in the corresponding [NamespaceDefinition]. See [NamespaceDefinition].

The parameter N is the type of entity type names and common type names in attributes/parents fields in this Fragment, including recursively. (It doesn’t affect the type of common and entity type names that are being declared here, which is always an UnreservedId and unambiguously refers to the InternalName with the appropriate implicit namespace prepended. It only affects the type of common and entity type references.) For example:

• N = RawName: This is the schema JSON format exposed to users
• N = ConditionalName: a Fragment which has been partially processed, by converting RawNames into ConditionalNames
• N = InternalName: a Fragment in which all names have been resolved into fully-qualified InternalNames

Tuple Fields

0: BTreeMap<Option<Name>, NamespaceDefinition<N>>

Implementations

impl Fragment<RawName>

pub fn from_json_str(json: &str) -> Result<Self>

Create a Fragment from a string containing JSON (which should be an object of the appropriate shape).

pub fn from_json_value(json: Value) -> Result<Self>

Create a Fragment from a JSON value (which should be an object of the appropriate shape).

pub fn from_json_file(file: impl Read) -> Result<Self>

Create a Fragment directly from a file containing a JSON object.

pub fn from_cedarschema_str<'a>( src: &str, extensions: &Extensions<'a>, ) -> Result<(Self, impl Iterator<Item = SchemaWarning> + 'a), CedarSchemaError>

Parse the schema (in the Cedar schema syntax) from a string

pub fn from_cedarschema_file<'a>( file: impl Read, extensions: &'a Extensions<'_>, ) -> Result<(Self, impl Iterator<Item = SchemaWarning> + 'a), CedarSchemaError>

Parse the schema (in the Cedar schema syntax) from a reader

impl<N: Display> Fragment<N>

pub fn to_cedarschema(&self) -> Result<String, ToCedarSchemaSyntaxError>

Pretty print this Fragment

Trait Implementations

impl<N: Clone> Clone for Fragment<N>

fn clone(&self) -> Fragment<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for Fragment<N>

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

Formats the value using the given formatter.

impl<'de, N> Deserialize<'de> for Fragment<N>

where N: Deserialize<'de> + From<RawName>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N: Display> Display for Fragment<N>

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

Formats the value using the given formatter.

impl<N: PartialEq> PartialEq for Fragment<N>

fn eq(&self, other: &Fragment<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<N: Serialize> Serialize for Fragment<N>

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

where S: Serializer,

Custom serializer to ensure that None is mapped to the empty namespace

impl TryFrom<Fragment<RawName>> for ValidatorSchema

type Error = SchemaError

The type returned in the event of a conversion error.

fn try_from(frag: Fragment<RawName>) -> Result<ValidatorSchema>

Performs the conversion.

impl TryInto<ValidatorSchemaFragment<ConditionalName, ConditionalName>> for Fragment<RawName>

type Error = SchemaError

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<ValidatorSchemaFragment<ConditionalName, ConditionalName>>

Performs the conversion.

impl<N> StructuralPartialEq for Fragment<N>