Skip to main content

App

Struct App 

Source
pub struct App {
    pub root: PathBuf,
    pub app: Crate,
    pub modules: Vec<Module>,
    pub identity: Option<Identity>,
    pub package_events: Vec<EventDeclaration>,
    pub packages: Vec<RoutedPackage>,
    pub split: Split,
    pub structure_ceilings: bool,
}

Fields§

§root: PathBuf§app: Crate§modules: Vec<Module>§identity: Option<Identity>§package_events: Vec<EventDeclaration>

Raised by the framework packages the app uses, which its listeners may hear.

§packages: Vec<RoutedPackage>

The framework packages other than sofie-identity whose routes the app serves.

§split: Split§structure_ceilings: bool

Set by [package.metadata.sofie] structure-ceilings = true.

Implementations§

Source§

impl App

Source

pub fn entitlements(&self) -> Entitlements<'_>

Source§

impl App

Source§

impl App

Source

pub fn areas(&self) -> Vec<KnownArea<'_>>

Source

pub fn area(&self, name: &str) -> Option<KnownArea<'_>>

Source

pub fn member_home(&self, area: &AreaDefinition) -> Option<String>

Source

pub fn depends_on(&self, package: &str) -> bool

Source

pub fn wiring_file(&self) -> PathBuf

Source

pub fn embedded_path(&self, file: &Path) -> Option<String>

From the app crate’s root, where embed! starts.

Source

pub fn route_sites(&self) -> Vec<RouteSite<'_>>

Source§

impl App

Source

pub fn package_routes(&self) -> PackageRoutes<'_>

Source§

impl App

Source

pub fn posted_route(&self, post: &str) -> Option<RouteSite<'_>>

The POST route the router serves post with; a bound path part is written {}.

Trait Implementations§

Source§

impl Clone for App

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for App

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for App

Source§

impl PartialEq for App

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for App

Auto Trait Implementations§

§

impl Forget for App

§

impl Freeze for App

§

impl RefUnwindSafe for App

§

impl Send for App

§

impl Sync for App

§

impl Unpin for App

§

impl UnsafeUnpin for App

§

impl UnwindSafe for App

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.