Struct DocumentationAssets

Source

pub struct DocumentationAssets;

Expand description

Embedded documentation EPUB file.

Contains the Cadmus documentation EPUB file generated from mdbook. Only the EPUB file is embedded, not the entire folder.

§Example

use cadmus_core::assets::DocumentationAssets;

let epub = DocumentationAssets::get_documentation();
assert!(!epub.data.is_empty());

Implementations§

Source §

impl DocumentationAssets

Source

fn matcher() -> PathMatcher

Source

pub fn get(file_path: &str) -> Option<EmbeddedFile>

Get an embedded file and its metadata.

Source

pub fn iter() -> impl Iterator<Item = Cow<'static, str>> + 'static

Iterates over the file paths in the folder.

Source §

impl DocumentationAssets

Source

pub fn get_documentation() -> EmbeddedFile

Returns the embedded documentation EPUB file.

§Panics

Panics if the documentation EPUB file is not found in embedded assets. This should never happen in a properly built binary.

§Example

use cadmus_core::assets::DocumentationAssets;

let epub = DocumentationAssets::get_documentation();
// The EPUB data is available as a byte slice
let data: &[u8] = &epub.data;

Trait Implementations§

Source §

impl RustEmbed for DocumentationAssets

Available on debug-assertions enabled only.

Source §

fn get(file_path: &str) -> Option<EmbeddedFile>

Get an embedded file and its metadata. Read more

Source §

fn iter() -> Filenames

Iterates over the file paths in the folder. Read more

Auto Trait Implementations§

§

impl UnwindSafe for DocumentationAssets

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

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §