EmbedOptions

Struct EmbedOptions 

Source
pub struct EmbedOptions {
    pub callbacks: Vec<CallbackSignature>,
    pub errbacks: Vec<CallbackSignature>,
    pub chain: Vec<CallbackSignature>,
    pub chord: Option<CallbackSignature>,
    pub group: Option<Uuid>,
    pub parent_id: Option<Uuid>,
    pub root_id: Option<Uuid>,
    pub extra: HashMap<String, Value>,
}
Expand description

Embed options in the message body

Fields§

§callbacks: Vec<CallbackSignature>

Callbacks to execute on success (link)

§errbacks: Vec<CallbackSignature>

Callbacks to execute on error (errback)

§chain: Vec<CallbackSignature>

Chain of tasks to execute after this one

§chord: Option<CallbackSignature>

Chord callback (executed after group completes)

§group: Option<Uuid>

Group ID

§parent_id: Option<Uuid>

Parent task ID

§root_id: Option<Uuid>

Root task ID

§extra: HashMap<String, Value>

Additional custom embed fields

Implementations§

Source§

impl EmbedOptions

Source

pub fn new() -> Self

Create new empty embed options

Source

pub fn with_callback(self, callback: CallbackSignature) -> Self

Add a success callback (link)

Source

pub fn with_errback(self, errback: CallbackSignature) -> Self

Add an error callback (errback)

Source

pub fn with_chain_task(self, task: CallbackSignature) -> Self

Add a chain task

Source

pub fn with_chord(self, chord: CallbackSignature) -> Self

Set the chord callback

Source

pub fn with_group(self, group: Uuid) -> Self

Set the group ID

Source

pub fn with_parent(self, parent_id: Uuid) -> Self

Set the parent task ID

Source

pub fn with_root(self, root_id: Uuid) -> Self

Set the root task ID

Source

pub fn has_callbacks(&self) -> bool

Check if there are any callbacks

Source

pub fn has_errbacks(&self) -> bool

Check if there are any errbacks

Source

pub fn has_chain(&self) -> bool

Check if there is a chain

Source

pub fn has_chord(&self) -> bool

Check if there is a chord

Source

pub fn has_workflow(&self) -> bool

Check if this has any workflow elements

Trait Implementations§

Source§

impl Clone for EmbedOptions

Source§

fn clone(&self) -> EmbedOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmbedOptions

Source§

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

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

impl Default for EmbedOptions

Source§

fn default() -> EmbedOptions

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EmbedOptions

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for EmbedOptions

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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

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

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

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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,