Struct rivet_chat::error::ForbiddenError

#[non_exhaustive]
pub struct ForbiddenError {
    pub code: Option<String>,
    pub message: Option<String>,
    pub metadata: Option<Document>,
}

An error thrown when the requestee requests a resource they do not have access to.

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.

code: Option<String>

message: Option<String>

metadata: Option<Document>

Unstructured metadata relating to an error. Must be manually parsed.

Implementations

impl ForbiddenError

pub fn code(&self) -> Option<&str>

pub fn metadata(&self) -> Option<&Document>

Unstructured metadata relating to an error. Must be manually parsed.

impl ForbiddenError

pub fn message(&self) -> Option<&str>

Returns the error message.

impl ForbiddenError

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ForbiddenError

Trait Implementations

impl Clone for ForbiddenError

fn clone(&self) -> ForbiddenError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForbiddenError

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

Formats the value using the given formatter.

impl Display for ForbiddenError

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

Formats the value using the given formatter.

impl Error for ForbiddenError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide(&'a self, req: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl PartialEq<ForbiddenError> for ForbiddenError

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ForbiddenError