Struct serenity_rich_interaction::menu::Menu

source · [−]

pub struct Menu<'a> {
    pub message: Arc<RwLock<MessageHandle>>,
    pub pages: Vec<Page<'a>>,
    pub current_page: usize,
    pub timeout: Instant,
    pub sticky: bool,
    pub data: TypeMap,
    /* private fields */
}

Expand description

A menu message

Fields

message: Arc<RwLock<MessageHandle>>pages: Vec<Page<'a>>current_page: usizetimeout: Instantsticky: booldata: TypeMap

Implementations

source

impl<'a> Menu<'a>

source

pub fn get_current_page(&self) -> Result<&Page<'a>>

Returns the current page of the menu

source

pub async fn get_message(&self, http: &Http) -> Result<Message>

Returns the message of the menu

source

pub async fn recreate(&self, http: &Http) -> Result<()>

Recreates the message completely

Trait Implementations

source

impl<'a> EventDrivenMessage for Menu<'a>

source

fn is_frozen(&self) -> bool

Returns if a message has been frozen and won’t handle any further events

source

fn update<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 http: &'life1 Http
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Fired periodically

source

fn on_reaction_add<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 ctx: &'life1 Context,
 reaction: Reaction
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Fired when a reaction was added to the message

source

fn on_deleted<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 _ctx: &'life1 Context
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Fired when the message was deleted

source

fn on_reaction_remove<'life0, 'life1, 'async_trait>(
 &'life0 mut self,
 _ctx: &'life1 Context,
 _reaction: Reaction
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Fired when a reaction was removed from the message

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Menu<'a>

impl<'a> Send for Menu<'a>

impl<'a> Sync for Menu<'a>

impl<'a> Unpin for Menu<'a>

impl<'a> !UnwindSafe for Menu<'a>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct serenity_rich_interaction::menu::Menu

Fields

Implementations

impl<'a> Menu<'a>

pub fn get_current_page(&self) -> Result<&Page<'a>>

pub async fn get_message(&self, http: &Http) -> Result<Message>

pub async fn recreate(&self, http: &Http) -> Result<()>

Trait Implementations

impl<'a> EventDrivenMessage for Menu<'a>

fn is_frozen(&self) -> bool

fn update<'life0, 'life1, 'async_trait>( &'life0 mut self, http: &'life1 Http) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn on_reaction_add<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 Context, reaction: Reaction) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn on_deleted<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 Context) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn on_reaction_remove<'life0, 'life1, 'async_trait>( &'life0 mut self, _ctx: &'life1 Context, _reaction: Reaction) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Menu<'a>

impl<'a> Send for Menu<'a>

impl<'a> Sync for Menu<'a>

impl<'a> Unpin for Menu<'a>

impl<'a> !UnwindSafe for Menu<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

fn update<'life0, 'life1, 'async_trait>(
&'life0 mut self,
http: &'life1 Http
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn on_reaction_add<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
reaction: Reaction
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn on_deleted<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_ctx: &'life1 Context
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn on_reaction_remove<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_ctx: &'life1 Context,
_reaction: Reaction
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,