Struct WorkspaceSpec

Source

pub struct WorkspaceSpec {
    pub id: SharedString,
    pub title: SharedString,
    pub icon: IconName,
    pub hint: SharedString,
    pub menus: Vec<MenuSpec>,
    pub view: AnyView,
    pub badge: Option<Rc<dyn Fn(&App) -> usize>>,
}

Expand description

A workspace of the app (Explore, Pipeline, Analyze; Sorting…).

Fields§

§id: SharedString

Its id (explore): the command shell.workspace.<id> switches to it.

§title: SharedString

Its name on the switcher.

§icon: IconName

Its icon on the switcher.

§hint: SharedString

What it is for (the switcher’s tooltip).

§menus: Vec<MenuSpec>

Its menu row.

§view: AnyView

What it shows.

§badge: Option<Rc<dyn Fn(&App) -> usize>>

A count shown on its switcher button when above zero (changed lines, unread messages).

Implementations§

Source §

impl WorkspaceSpec

Source

pub fn new( id: impl Into<SharedString>, title: impl Into<SharedString>, icon: IconName, view: impl Into<AnyView>, ) -> Self

A workspace id titled title, showing view.

Source

pub fn hint(self, hint: impl Into<SharedString>) -> Self

Sets what it is for.

Source

pub fn menus(self, menus: Vec<MenuSpec>) -> Self

Sets its menu row.

Source

pub fn badge(self, count: impl Fn(&App) -> usize + 'static) -> Self

Shows count on its switcher button when above zero.

Auto Trait Implementations§

§

impl UnsafeUnpin for WorkspaceSpec

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

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

Source §

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

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

Source §

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

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

Source §

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

Convert &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)

Convert &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> Downcast<T> for T

Source §

fn downcast(&self) -> &T

Source §

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

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

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

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

Source §

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

Source §