flams_system::backend

Struct GlobalBackend

Source 
pub struct GlobalBackend {
    archives: ArchiveManager,
    cache: RwLock<BackendCache>,
    triple_store: RDFStore,
}

Fields§

§archives: ArchiveManager§cache: RwLock<BackendCache>§triple_store: RDFStore

Implementations§

Source§

impl GlobalBackend

Source

pub fn get() -> &'static Self
where Self: Sized,

Source

pub fn initialize()

Source

pub fn new_archive( &self, id: &ArchiveId, base_uri: &BaseURI, format: &str, default_file: &str, content: &str, ) -> Result<PathBuf, Report>

Source

pub fn artifact_path(&self, uri: &DocumentURI, format: &str) -> Option<PathBuf>

Source

pub fn with_archive_tree<R>(&self, f: impl FnOnce(&ArchiveTree) -> R) -> R

Source

pub fn reset(&self)

Source

pub async fn get_html_body_async( &self, d: &DocumentURI, full: bool, ) -> Option<(Vec<CSS>, String)>

Available on crate feature tokio only.
Source

pub async fn get_html_full_async(&self, d: &DocumentURI) -> Option<String>

Available on crate feature tokio only.
Source

pub async fn get_html_fragment_async( &self, d: &DocumentURI, range: DocumentRange, ) -> Option<(Vec<CSS>, String)>

Available on crate feature tokio only.
Source

pub const fn manager(&self) -> &ArchiveManager

Source

pub const fn triple_store(&self) -> &RDFStore

Source

pub fn all_archives(&self) -> impl Deref<Target = [Archive]> + '_

Source

pub async fn get_document_async(&self, uri: &DocumentURI) -> Option<Document>

Available on crate feature tokio only.
Source

pub async fn get_module_async(&self, uri: &ModuleURI) -> Option<ModuleLike>

Available on crate feature tokio only.
Source

pub async fn get_declaration_async<T: DeclarationTrait>( &self, uri: &SymbolURI, ) -> Option<ContentReference<T>>

Available on crate feature tokio only.
Source

pub async fn get_document_element_async<T: NarrationTrait>( &self, uri: &DocumentElementURI, ) -> Option<NarrativeReference<T>>

Available on crate feature tokio only.

Trait Implementations§

Source§

impl Backend for &'static GlobalBackend

Source§

type ArchiveIter<'a> = Iter<'a, Archive>

Source§

fn to_any(&self) -> AnyBackend

Source§

fn get_html_body( &self, d: &DocumentURI, full: bool, ) -> Option<(Vec<CSS>, String)>

Source§

fn get_html_full(&self, d: &DocumentURI) -> Option<String>

Source§

fn get_html_fragment( &self, d: &DocumentURI, range: DocumentRange, ) -> Option<(Vec<CSS>, String)>

Source§

fn get_reference<T: Resourcable>(&self, rf: &LazyDocRef<T>) -> Result<T>

Source§

fn submit_triples( &self, in_doc: &DocumentURI, rel_path: &str, iter: impl Iterator<Item = Triple>, )

Source§

fn with_archives<R>(&self, f: impl FnOnce(Self::ArchiveIter<'_>) -> R) -> R
where Self: Sized,

Source§

fn with_archive<R>( &self, id: &ArchiveId, f: impl FnOnce(Option<&Archive>) -> R, ) -> R

Source§

fn with_local_archive<R>( &self, id: &ArchiveId, f: impl FnOnce(Option<&LocalArchive>) -> R, ) -> R

Source§

fn with_archive_or_group<R>( &self, id: &ArchiveId, f: impl FnOnce(Option<&ArchiveOrGroup>) -> R, ) -> R

Source§

fn get_document(&self, uri: &DocumentURI) -> Option<Document>

Source§

fn get_module(&self, uri: &ModuleURI) -> Option<ModuleLike>

Source§

fn get_base_path(&self, id: &ArchiveId) -> Option<PathBuf>

Source§

fn get_declaration<T: DeclarationTrait>( &self, uri: &SymbolURI, ) -> Option<ContentReference<T>>

Source§

fn presenter(&self) -> StringPresenter<'_, Self>
where Self: Sized,

Source§

fn get_document_element<T: NarrationTrait>( &self, uri: &DocumentElementURI, ) -> Option<NarrativeReference<T>>
where Self: Sized,

Source§

fn uri_of(&self, p: &Path) -> Option<DocumentURI>
where Self: Sized,

Source§

fn archive_of<R>( &self, p: &Path, f: impl FnMut(&LocalArchive, &str) -> R, ) -> Option<R>
where Self: Sized,

Source§

fn get_notations( &self, uri: &SymbolURI, ) -> Option<VecSet<(DocumentElementURI, Notation)>>
where Self: Sized,

Source§

fn get_var_notations( &self, uri: &DocumentElementURI, ) -> Option<VecSet<(DocumentElementURI, Notation)>>
where Self: Sized,

Source§

fn as_checker(&self) -> AsChecker<'_, Self>
where Self: Sized,

Source§

impl Backend for GlobalBackend

Source§

type ArchiveIter<'a> = Iter<'a, Archive>

Source§

fn to_any(&self) -> AnyBackend

Source§

fn get_html_fragment( &self, d: &DocumentURI, range: DocumentRange, ) -> Option<(Vec<CSS>, String)>

Source§

fn get_reference<T: Resourcable>(&self, rf: &LazyDocRef<T>) -> Result<T>

Source§

fn with_archives<R>(&self, f: impl FnOnce(Self::ArchiveIter<'_>) -> R) -> R
where Self: Sized,

Source§

fn get_html_body( &self, d: &DocumentURI, full: bool, ) -> Option<(Vec<CSS>, String)>

Source§

fn get_html_full(&self, d: &DocumentURI) -> Option<String>

Source§

fn submit_triples( &self, in_doc: &DocumentURI, rel_path: &str, iter: impl Iterator<Item = Triple>, )

Source§

fn with_archive<R>( &self, id: &ArchiveId, f: impl FnOnce(Option<&Archive>) -> R, ) -> R

Source§

fn with_archive_or_group<R>( &self, id: &ArchiveId, f: impl FnOnce(Option<&ArchiveOrGroup>) -> R, ) -> R

Source§

fn get_base_path(&self, id: &ArchiveId) -> Option<PathBuf>

Source§

fn get_document(&self, uri: &DocumentURI) -> Option<Document>

Source§

fn get_module(&self, uri: &ModuleURI) -> Option<ModuleLike>

Source§

fn presenter(&self) -> StringPresenter<'_, Self>
where Self: Sized,

Source§

fn get_declaration<T: DeclarationTrait>( &self, uri: &SymbolURI, ) -> Option<ContentReference<T>>
where Self: Sized,

Source§

fn get_document_element<T: NarrationTrait>( &self, uri: &DocumentElementURI, ) -> Option<NarrativeReference<T>>
where Self: Sized,

Source§

fn uri_of(&self, p: &Path) -> Option<DocumentURI>
where Self: Sized,

Source§

fn archive_of<R>( &self, p: &Path, f: impl FnMut(&LocalArchive, &str) -> R, ) -> Option<R>
where Self: Sized,

Source§

fn with_local_archive<R>( &self, id: &ArchiveId, f: impl FnOnce(Option<&LocalArchive>) -> R, ) -> R
where Self: Sized,

Source§

fn get_notations( &self, uri: &SymbolURI, ) -> Option<VecSet<(DocumentElementURI, Notation)>>
where Self: Sized,

Source§

fn get_var_notations( &self, uri: &DocumentElementURI, ) -> Option<VecSet<(DocumentElementURI, Notation)>>
where Self: Sized,

Source§

fn as_checker(&self) -> AsChecker<'_, Self>
where Self: Sized,

Source§

impl Debug for GlobalBackend

Source§

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

Formats the value using the given formatter. Read more

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
§

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§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The type for metadata in pointers and references to Self.
§

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

§

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
§

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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Fruit for T
where T: Send + Downcast,