Struct Status 

pub struct Status {
    pub status: Option<StatusSummary>,
    pub code: u16,
    pub message: String,
    pub metadata: Option<ListMeta>,
    pub reason: String,
    pub details: Option<StatusDetails>,
}

A Kubernetes status object

This struct is returned by the Kubernetes API on failures, and bubbles up to users inside a [kube::Error::Api] variant when client requests fail in [kube::Client].

To match on specific error cases, you can;

match err {
    kube::Error::Api(s) if s.is_not_found() => {...},
}

or in a standalone if statement with std::matches;

if std::matches!(err, kube::Error::Api(s) if s.is_forbidden()) {...}

Fields

status: Option<StatusSummary>

Status of the operation

One of: Success or Failure - more info

code: u16

Suggested HTTP return code (0 if unset)

message: String

A human-readable description of the status of this operation

metadata: Option<ListMeta>

Standard list metadata - more info

reason: String

A machine-readable description of why this operation is in the “Failure” status.

If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

details: Option<StatusDetails>

Extended data associated with the reason.

Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

Implementations

impl Status

pub fn boxed(self) -> Box<Status>

Returns a boxed Status

pub fn success() -> Status

Returns a successful Status

pub fn failure(message: &str, reason: &str) -> Status

Returns an unsuccessful Status

pub fn with_code(self, code: u16) -> Status

Sets an explicit HTTP status code

pub fn with_details(self, details: StatusDetails) -> Status

Adds details to the Status

pub fn is_success(&self) -> bool

Checks if this Status represents success

Note that it is possible for Status to be in indeterminate state when both is_success and is_failure return false.

pub fn is_failure(&self) -> bool

Checks if this Status represents failure

Note that it is possible for Status to be in indeterminate state when both is_success and is_failure return false.

pub fn is_not_found(&self) -> bool

Checks if this Status represents not found error

Note that it is possible for Status to be in indeterminate state when both is_success and is_failure return false.

pub fn is_already_exists(&self) -> bool

Checks if this Status indicates that a specified resource already exists.

pub fn is_conflict(&self) -> bool

Checks if this Status indicates update conflict

pub fn is_forbidden(&self) -> bool

Checks if this Status indicates that the request is forbidden and cannot be completed as requested.

pub fn is_invalid(&self) -> bool

Checks if this Status indicates that provided resource is not valid.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Status

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Status

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

Formats the value using the given formatter.

impl Error for Status

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

Returns 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>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for Status

fn eq(&self, other: &Status) -> 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 Status

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Status