Struct StartCommercial

#[non_exhaustive]
pub struct StartCommercial {
    pub length: CommercialLength,
    pub message: String,
    pub retry_after: u64,
}

Available on crate feature helix only.

Return Values for Start Commercial

start-commercial

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

length: CommercialLength

Length of the triggered commercial

message: String

Provides contextual information on why the request failed

retry_after: u64

Seconds until the next commercial can be served on this channel

Trait Implementations

impl Clone for StartCommercial

fn clone(&self) -> StartCommercial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartCommercial

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StartCommercial

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StartCommercial

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StartCommercial

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StartCommercial

impl StructuralPartialEq for StartCommercial