pub struct EngineState {
pub config: GlobalConfig,
pub config_path: PathBuf,
pub state_dir: PathBuf,
pub spaces: HashMap<String, Arc<SpaceContext>>,
}Expand description
Shared mutable state protected by WikiEngine’s RwLock.
Fields§
§config: GlobalConfigLoaded global configuration.
config_path: PathBufAbsolute path to the global config file on disk.
state_dir: PathBufDirectory that holds per-wiki index state (parent of the config file).
spaces: HashMap<String, Arc<SpaceContext>>Map from wiki name to its mounted SpaceContext.
Implementations§
Source§impl EngineState
impl EngineState
Sourcepub fn default_wiki_name(&self) -> &str
pub fn default_wiki_name(&self) -> &str
Return the configured default wiki name.
Sourcepub fn space(&self, name: &str) -> Result<&Arc<SpaceContext>>
pub fn space(&self, name: &str) -> Result<&Arc<SpaceContext>>
Look up a mounted wiki space by name. Errors if not mounted.
Sourcepub fn resolve_wiki_name<'a>(&'a self, explicit: Option<&'a str>) -> &'a str
pub fn resolve_wiki_name<'a>(&'a self, explicit: Option<&'a str>) -> &'a str
Return explicit if given, otherwise the default wiki name.
Sourcepub fn index_path_for(&self, wiki_name: &str) -> PathBuf
pub fn index_path_for(&self, wiki_name: &str) -> PathBuf
Return the index directory path for a wiki by name.
Auto Trait Implementations§
impl Freeze for EngineState
impl !RefUnwindSafe for EngineState
impl Send for EngineState
impl Sync for EngineState
impl Unpin for EngineState
impl UnsafeUnpin for EngineState
impl !UnwindSafe for EngineState
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn 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.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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.Source§fn as_any(&self) -> &(dyn Any + 'static)
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.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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