SectionQuery

Struct SectionQuery 

Source
pub struct SectionQuery<'a> { /* private fields */ }
Expand description

Allows chained queries deep down into a document hierarchy without having to manually handle possibly missing sections in between. If the terminal/leaf element/value of a query chain is required, the first missing element in the chain will be “bubbled” up as the cause of the error.

Note that chaining still returns a Result<*, enolib::Error> at every step, due to the fact that a query step may not only fail due to a (potentially graceful) missing element, but also due to ambiguous results (e.g. two sections with the same key), which is an immediate hard error. Hint: Use the idiomatic approach with the ? operator to create nicely readable code with this API.

Implementations§

Source§

impl<'a> SectionQuery<'a>

Source

pub fn elements(&self) -> &[Box<dyn SectionElement>]

Source

pub fn embed(&self, key: &str) -> Result<EmbedQuery<'_>, Error>

Source

pub fn field(&self, key: &str) -> Result<FieldQuery<'_>, Error>

Source

pub fn flag(&self, key: &str) -> Result<FlagQuery<'_>, Error>

Source

pub fn missing_error(&self) -> Error

Source

pub fn section(&self, key: &str) -> Result<SectionQuery<'_>, Error>

Source

pub fn snippet(&self) -> Result<String, Error>

Source

pub fn snippet_with_options( &self, printer: &dyn Printer, gutter: bool, ) -> Result<String, Error>

Auto Trait Implementations§

§

impl<'a> Freeze for SectionQuery<'a>

§

impl<'a> !RefUnwindSafe for SectionQuery<'a>

§

impl<'a> !Send for SectionQuery<'a>

§

impl<'a> !Sync for SectionQuery<'a>

§

impl<'a> Unpin for SectionQuery<'a>

§

impl<'a> !UnwindSafe for SectionQuery<'a>

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, 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, 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.