Struct rocket::fairing::Kind

pub struct Kind(_);

A bitset representing the kinds of callbacks a Fairing wishes to receive.

A fairing can request any combination of any of the following kinds of callbacks:

• Ignite
• Liftoff
• Request
• Response
• Shutdown

Two Kind structures can be ord together to represent a combination. For instance, to represent a fairing that is both an ignite and request fairing, use Kind::Ignite | Kind::Request. Similarly, to represent a fairing that is only an ignite fairing, use Kind::Ignite.

Additionally, a fairing can request to be treated as a singleton by specifying the Singleton kind.

Implementations

impl Kind

pub const Ignite: Kind = Kind(1 << 0)

Kind flag representing a request for a ‘ignite’ callback.

pub const Liftoff: Kind = Kind(1 << 1)

Kind flag representing a request for a ‘liftoff’ callback.

pub const Request: Kind = Kind(1 << 2)

Kind flag representing a request for a ‘request’ callback.

pub const Response: Kind = Kind(1 << 3)

Kind flag representing a request for a ‘response’ callback.

pub const Shutdown: Kind = Kind(1 << 4)

Kind flag representing a request for a ‘shutdown’ callback.

pub const Singleton: Kind = Kind(1 << 5)

Kind flag representing a singleton fairing.

pub fn is(self, other: Kind) -> bool

Returns true if self is a superset of other. In other words, returns true if all of the kinds in other are also in self.

Example

use rocket::fairing::Kind;

let ignite_and_req = Kind::Ignite | Kind::Request;
assert!(ignite_and_req.is(Kind::Ignite | Kind::Request));

assert!(ignite_and_req.is(Kind::Ignite));
assert!(ignite_and_req.is(Kind::Request));

assert!(!ignite_and_req.is(Kind::Liftoff));
assert!(!ignite_and_req.is(Kind::Response));
assert!(!ignite_and_req.is(Kind::Ignite | Kind::Response));
assert!(!ignite_and_req.is(Kind::Ignite | Kind::Request | Kind::Response));

pub fn is_exactly(self, other: Kind) -> bool

Returns true if self is exactly other.

Example

use rocket::fairing::Kind;

let ignite_and_req = Kind::Ignite | Kind::Request;
assert!(ignite_and_req.is_exactly(Kind::Ignite | Kind::Request));

assert!(!ignite_and_req.is_exactly(Kind::Ignite));
assert!(!ignite_and_req.is_exactly(Kind::Request));
assert!(!ignite_and_req.is_exactly(Kind::Response));
assert!(!ignite_and_req.is_exactly(Kind::Ignite | Kind::Response));

Trait Implementations

impl BitOr<Kind> for Kind

type Output = Kind

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl Display for Kind

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

Formats the value using the given formatter.

impl Copy for Kind