Struct ExtensionFile 

pub struct ExtensionFile { /* private fields */ }

Available on crate feature parse only.

A parsed and validated RawExtensions: a simple extensions file.

An ExtensionFile has a canonical Urn and a parsed set of SimpleExtensions data. It represents the extensions file as a whole.

Implementations

impl ExtensionFile

pub fn empty(urn: Urn) -> Self

Create a new, empty ExtensionFile with an empty set of SimpleExtensions.

pub fn create(extensions: RawExtensions) -> Result<Self, SimpleExtensionsError>

Create an ExtensionFile from raw simple extension data.

pub fn get_type(&self, name: &str) -> Option<&CustomType>

Get a type by name

pub fn types(&self) -> impl Iterator<Item = &CustomType>

Get an iterator over all types in this extension

pub fn urn(&self) -> &Urn

Returns the Urn` for this extension file.

pub fn extension(&self) -> &SimpleExtensions

Get a reference to the underlying SimpleExtensions.

pub fn into_raw(self) -> RawExtensions

Convert the parsed extension file back into the raw text representation by value.

pub fn to_raw(&self) -> RawExtensions

Convert the parsed extension file back into the raw text representation by reference.

pub fn read<R: Read>(reader: R) -> Result<Self, SimpleExtensionsError>

Read an extension file from a reader.

• reader: any Read instance with the YAML content

Returns a parsed and validated ExtensionFile or an error.

pub fn read_from_str<S: AsRef<str>>(s: S) -> Result<Self, SimpleExtensionsError>

Read an extension file from a string slice.

Trait Implementations

impl Debug for ExtensionFile

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

Formats the value using the given formatter.