Skip to main content

Effect

Enum Effect

pub enum Effect {
    Render(Request<RenderOperation>),
    PluginNotify(Request<PluginNotify>),
    Plugin(Request<PluginCall>),
    PluginStream(Request<PluginStreamCall>),
}

Expand description

Built-in capabilities the generic shell fulfils.

Variants§

Render(Request<RenderOperation>)

PluginNotify(Request<PluginNotify>)

Plugin(Request<PluginCall>)

PluginStream(Request<PluginStreamCall>)

Implementations§

impl Effect

pub fn is_render(&self) -> bool

pub fn into_render(self) -> Option<Request<RenderOperation>>

impl Effect

pub fn is_plugin_notify(&self) -> bool

pub fn into_plugin_notify(self) -> Option<Request<PluginNotify>>

impl Effect

pub fn is_plugin(&self) -> bool

pub fn into_plugin(self) -> Option<Request<PluginCall>>

impl Effect

pub fn is_plugin_stream(&self) -> bool

pub fn into_plugin_stream(self) -> Option<Request<PluginStreamCall>>

Trait Implementations§

impl Debug for Effect

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

Formats the value using the given formatter. Read more

impl Effect for Effect

impl EffectFFI for Effect

type Ffi = EffectFfi

Ffi is an enum with variants corresponding to the Effect variants but instead of carrying a Request<Op> they carry the Op directly

fn serialize<T: FfiFormat>(self) -> (Self::Ffi, ResolveSerialized<T>)

Converts the Effect into its FFI counterpart and returns it alongside a deserializing version of the resolve callback for the request that the original Effect was carrying. Read more

impl From<Request<PluginCall>> for Effect

fn from(value: Request<PluginCall>) -> Self

Converts to this type from the input type.

impl From<Request<PluginNotify>> for Effect

fn from(value: Request<PluginNotify>) -> Self

Converts to this type from the input type.

impl From<Request<PluginStreamCall>> for Effect

fn from(value: Request<PluginStreamCall>) -> Self

Converts to this type from the input type.

impl From<Request<RenderOperation>> for Effect

fn from(value: Request<RenderOperation>) -> Self

Converts to this type from the input type.

impl TryFrom<Effect> for Request<RenderOperation>

type Error = Effect

The type returned in the event of a conversion error.

fn try_from(value: Effect) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Effect> for Request<PluginNotify>

type Error = Effect

The type returned in the event of a conversion error.

fn try_from(value: Effect) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Effect> for Request<PluginCall>

type Error = Effect

The type returned in the event of a conversion error.

fn try_from(value: Effect) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Effect> for Request<PluginStreamCall>

type Error = Effect

The type returned in the event of a conversion error.

fn try_from(value: Effect) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl !RefUnwindSafe for Effect

impl !Sync for Effect

impl !UnwindSafe for Effect

impl Freeze for Effect

impl Send for Effect

impl Unpin for Effect

impl UnsafeUnpin for Effect

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.