Struct InboxRequest 

pub struct InboxRequest {
    pub since_unix_ms: Option<u64>,
    pub limit: u16,
    pub wait_secs: Option<u16>,
}

Requests a page of the caller’s inbox. limit defaults to INBOX_LIMIT_DEFAULT when a caller’s JSON omits it, and is bounded by INBOX_LIMIT_MAX.

Fields

since_unix_ms: Option<u64>

limit: u16

wait_secs: Option<u16>

Long-polls when a read would otherwise answer an empty page: waits up to this many seconds for mail to arrive for the caller (or a room the caller currently belongs to) before answering, rather than returning empty at once. Clamped to INBOX_WAIT_SECS_MAX – not refused – when a caller asks for longer; see that constant’s own doc comment for why. Answers an empty page on expiry, never an error: waiting and finding nothing is not a refusal. None (the default when a caller’s JSON omits this field) keeps today’s behaviour exactly: an empty inbox answers empty at once, with no wait at all.

Implementations

impl InboxRequest

pub fn validate(&self) -> Result<(), MailError>

Trait Implementations

impl Clone for InboxRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InboxRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InboxRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InboxRequest

impl PartialEq for InboxRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InboxRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InboxRequest