Enum rocket::http::Method

#[non_exhaustive]
pub enum Method {
Show 38 variants Get, Head, Post, Put, Delete, Connect, Options, Trace, Patch, Acl, BaselineControl, Bind, CheckIn, CheckOut, Copy, Label, Link, Lock, Merge, MkActivity, MkCalendar, MkCol, MkRedirectRef, MkWorkspace, Move, OrderPatch, PropFind, PropPatch, Rebind, Report, Search, Unbind, Uncheckout, Unlink, Unlock, Update, UpdateRedirectRef, VersionControl,
}
Expand description

An HTTP method.

Each variant corresponds to a method in the HTTP Method Registry. The string form of the method can be obtained via Method::as_str() and parsed via the FromStr or TryFrom<&[u8]> implementations. The parse implementations parse both the case-sensitive string form as well as a lowercase version of the string, but not mixed-case versions.

§(De)Serialization

Method is both Serialize and Deserialize.

  • Method serializes as the specification-defined string form of the method, equivalent to the value returned from Method::as_str().
  • Method deserializes from method’s string form or from a lowercased string, equivalent to the FromStr implementation.

For example, Method::Get serializes to "GET" and deserializes from either "GET" or "get" but not "GeT".

use rocket::http::Method;
use rocket::serde::{Serialize, Deserialize};

#[derive(Deserialize, Serialize)]
#[serde(crate = "rocket::serde")]
struct Foo {
    method: Method,
}

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Get

The GET method. Defined in RFC9110 §9.3.1.

  • safe: yes
  • idempotent: yes
  • request body: maybe
§

Head

The HEAD method. Defined in RFC9110 §9.3.2.

  • safe: yes
  • idempotent: yes
  • request body: maybe
§

Post

The POST method. Defined in RFC9110 §9.3.3.

  • safe: no
  • idempotent: no
  • request body: yes
§

Put

The PUT method. Defined in RFC9110 §9.3.4.

  • safe: no
  • idempotent: yes
  • request body: yes
§

Delete

The DELETE method. Defined in RFC9110 §9.3.5.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

Connect

The CONNECT method. Defined in RFC9110 §9.3.6.

  • safe: no
  • idempotent: no
  • request body: maybe
§

Options

The OPTIONS method. Defined in RFC9110 §9.3.7.

  • safe: yes
  • idempotent: yes
  • request body: maybe
§

Trace

The TRACE method. Defined in RFC9110 §9.3.8.

  • safe: yes
  • idempotent: yes
  • request body: no
§

Patch

The PATCH method. Defined in RFC5789 §2.

  • safe: no
  • idempotent: no
  • request body: yes
§

Acl

The ACL method. Defined in RFC3744 §8.1.

  • safe: no
  • idempotent: yes
  • request body: yes
§

BaselineControl

The BASELINE-CONTROL method. Defined in RFC3253 §12.6.

  • safe: no
  • idempotent: yes
  • request body: yes
§

Bind

The BIND method. Defined in RFC5842 §4.

  • safe: no
  • idempotent: yes
  • request body: yes
§

CheckIn

The CHECKIN method. Defined in RFC3253 §4.4.

  • safe: no
  • idempotent: yes
  • request body: yes
§

CheckOut

The CHECKOUT method. Defined in RFC3253 §4.3.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

Copy

The COPY method. Defined in RFC4918 §9.8.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

Label

The LABEL method. Defined in RFC3253 §8.2.

  • safe: no
  • idempotent: yes
  • request body: yes

The LINK method. Defined in RFC2068 §19.6.1.2.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

Lock

The LOCK method. Defined in RFC4918 §9.10.

  • safe: no
  • idempotent: no
  • request body: yes
§

Merge

The MERGE method. Defined in RFC3253 §11.2.

  • safe: no
  • idempotent: yes
  • request body: yes
§

MkActivity

The MKACTIVITY method. Defined in RFC3253 §13.5.

  • safe: no
  • idempotent: yes
  • request body: yes
§

MkCalendar

The MKCALENDAR method. Defined in RFC4791 §5.3.1, RFC8144 §2.3.

  • safe: no
  • idempotent: yes
  • request body: yes
§

MkCol

The MKCOL method. Defined in RFC4918 §9.3, RFC5689 §3, RFC8144 §2.3.

  • safe: no
  • idempotent: yes
  • request body: yes
§

MkRedirectRef

The MKREDIRECTREF method. Defined in RFC4437 §6.

  • safe: no
  • idempotent: yes
  • request body: yes
§

MkWorkspace

The MKWORKSPACE method. Defined in RFC3253 §6.3.

  • safe: no
  • idempotent: yes
  • request body: yes
§

Move

The MOVE method. Defined in RFC4918 §9.9.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

OrderPatch

The ORDERPATCH method. Defined in RFC3648 §7.

  • safe: no
  • idempotent: yes
  • request body: yes
§

PropFind

The PROPFIND method. Defined in RFC4918 §9.1, RFC8144 §2.1.

  • safe: yes
  • idempotent: yes
  • request body: yes
§

PropPatch

The PROPPATCH method. Defined in RFC4918 §9.2, RFC8144 §2.2.

  • safe: no
  • idempotent: yes
  • request body: yes
§

Rebind

The REBIND method. Defined in RFC5842 §6.

  • safe: no
  • idempotent: yes
  • request body: yes
§

Report

The REPORT method. Defined in RFC3253 §3.6, RFC8144 §2.1.

  • safe: yes
  • idempotent: yes
  • request body: yes
§

Search

The SEARCH method. Defined in RFC5323 §2.

  • safe: yes
  • idempotent: yes
  • request body: yes
§

Unbind

The UNBIND method. Defined in RFC5842 §5.

  • safe: no
  • idempotent: yes
  • request body: yes
§

Uncheckout

The UNCHECKOUT method. Defined in RFC3253 §4.5.

  • safe: no
  • idempotent: yes
  • request body: maybe

The UNLINK method. Defined in RFC2068 §19.6.1.3.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

Unlock

The UNLOCK method. Defined in RFC4918 §9.11.

  • safe: no
  • idempotent: yes
  • request body: maybe
§

Update

The UPDATE method. Defined in RFC3253 §7.1.

  • safe: no
  • idempotent: yes
  • request body: yes
§

UpdateRedirectRef

The UPDATEREDIRECTREF method. Defined in RFC4437 §7.

  • safe: no
  • idempotent: yes
  • request body: yes
§

VersionControl

The VERSION-CONTROL method. Defined in RFC3253 §3.5.

  • safe: no
  • idempotent: yes
  • request body: yes

Implementations§

§

impl Method

pub const fn is_safe(&self) -> bool

Whether the method is considered “safe”.

From RFC9110 §9.2.1:

Request methods are considered “safe” if their defined semantics are essentially read-only; i.e., the client does not request, and does not expect, any state change on the origin server as a result of applying a safe method to a target resource. Likewise, reasonable use of a safe method is not expected to cause any harm, loss of property, or unusual burden on the origin server. Of the request methods defined by this specification, the GET, HEAD, OPTIONS, and TRACE methods are defined to be safe.

§Example
use rocket::http::Method;

assert!(Method::Get.is_safe());
assert!(Method::Head.is_safe());

assert!(!Method::Put.is_safe());
assert!(!Method::Post.is_safe());

pub const fn is_idempotent(&self) -> bool

Whether the method is considered “idempotent”.

From RFC9110 §9.2.2:

A request method is considered “idempotent” if the intended effect on the server of multiple identical requests with that method is the same as the effect for a single such request. Of the request methods defined by this specification, PUT, DELETE, and safe request methods are idempotent.

§Example
use rocket::http::Method;

assert!(Method::Get.is_idempotent());
assert!(Method::Head.is_idempotent());
assert!(Method::Put.is_idempotent());

assert!(!Method::Post.is_idempotent());
assert!(!Method::Patch.is_idempotent());

pub const fn allows_request_body(self) -> Option<bool>

Whether requests with this method are allowed to have a body.

Returns:

  • Some(true) if a request body is always allowed.
  • Some(false) if a request body is never allowed.
  • None if a request body is discouraged or has no defined semantics.
§Example
use rocket::http::Method;

assert_eq!(Method::Post.allows_request_body(), Some(true));
assert_eq!(Method::Put.allows_request_body(), Some(true));

assert_eq!(Method::Trace.allows_request_body(), Some(false));

assert_eq!(Method::Get.allows_request_body(), None);
assert_eq!(Method::Head.allows_request_body(), None);

pub const fn as_str(self) -> &'static str

Returns the method’s string representation.

§Example
use rocket::http::Method;

assert_eq!(Method::Get.as_str(), "GET");
assert_eq!(Method::Put.as_str(), "PUT");
assert_eq!(Method::BaselineControl.as_str(), "BASELINE-CONTROL");

pub const fn as_ref(self) -> &'static Method

Returns a static reference to the method.

§Example
use rocket::http::Method;

assert_eq!(Method::Get.as_ref(), &Method::Get);
§

impl Method

pub const fn supports_payload(self) -> bool

👎Deprecated since 0.6.0: use Self::allows_request_body()

Deprecated. Returns self.allows_request_body() == Some(true).

Use Method::allows_request_body() instead.

Trait Implementations§

§

impl AsRef<str> for Method

§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
§

impl Clone for Method

§

fn clone(&self) -> Method

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Method

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for Method

§

fn deserialize<D>( deserializer: D ) -> Result<Method, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for Method

§

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

Formats the value using the given formatter. Read more
source§

impl<'r> FromRequest<'r> for Method

§

type Error = Infallible

The associated error to be returned if derivation fails.
source§

fn from_request<'life0, 'async_trait>( request: &'r Request<'life0> ) -> Pin<Box<dyn Future<Output = Outcome<Self, Infallible>> + Send + 'async_trait>>
where Self: 'async_trait, 'r: 'async_trait, 'life0: 'async_trait,

Derives an instance of Self from the incoming request metadata. Read more
§

impl FromStr for Method

§

type Err = ParseMethodError

The associated error which can be returned from parsing.
§

fn from_str(s: &str) -> Result<Method, <Method as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl Hash for Method

§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq<&Method> for Method

§

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

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

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 PartialEq<Method> for &Method

§

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

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

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 PartialEq for Method

§

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

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

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 Serialize for Method

§

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. Read more
§

impl TryFrom<&[u8]> for Method

§

type Error = ParseMethodError

The type returned in the event of a conversion error.
§

fn try_from(value: &[u8]) -> Result<Method, <Method as TryFrom<&[u8]>>::Error>

Performs the conversion.
§

impl Copy for Method

§

impl Eq for Method

§

impl StructuralPartialEq for Method

Auto Trait Implementations§

§

impl Freeze for Method

§

impl RefUnwindSafe for Method

§

impl Send for Method

§

impl Sync for Method

§

impl Unpin for Method

§

impl UnwindSafe for Method

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

source§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> AsUncased for T
where T: AsRef<str> + ?Sized,

source§

fn as_uncased(&self) -> &UncasedStr

Convert self to an UncasedStr.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Paint for T
where T: ?Sized,

source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

§Example
println!("{}", value.bright_black());
source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

§Example
println!("{}", value.bright_green());
source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

§Example
println!("{}", value.bright_magenta());
source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

§Example
println!("{}", value.bright_white());
source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

§Example
println!("{}", value.on_bright_black());
source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

§Example
println!("{}", value.on_bright_green());
source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

§Example
println!("{}", value.on_bright_blue());
source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

§Example
println!("{}", value.on_bright_cyan());
source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> Upcast<T> for U
where T: UpcastFrom<U>,

source§

fn upcast(self) -> T

source§

impl<T, B> UpcastFrom<Counter<T, B>> for T

source§

fn upcast_from(value: Counter<T, B>) -> T

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> CustomEndpoint for T
where T: Display + Debug + Sync + Send + Any,

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,