Skip to main content

Arguments

Struct Arguments 

Source
pub struct Arguments<'fmt, Context>(pub &'fmt [Argument<'fmt, Context>]);
Expand description

Sequence of objects that should be formatted in the specified order.

The format_args! macro will safely create an instance of this structure.

You can use the Arguments<a> that format_args! return in Format context as seen below. It will call the format function for each of its objects.

use ruff_formatter::prelude::*;
use ruff_formatter::{format, format_args};

let formatted = format!(SimpleFormatContext::default(), [
    format_args!(token("a"), space(), token("b"))
])?;

assert_eq!("a b", formatted.print()?.as_code());

Tuple Fields§

§0: &'fmt [Argument<'fmt, Context>]

Trait Implementations§

Source§

impl<Context> Clone for Arguments<'_, Context>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Context> Copy for Arguments<'_, Context>

Source§

impl<Context> Debug for Arguments<'_, Context>

Source§

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

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

impl<Context> Format<Context> for Arguments<'_, Context>

Source§

fn fmt(&self, formatter: &mut Formatter<'_, Context>) -> FormatResult<()>

Formats the object using the given formatter.
Source§

impl<'fmt, Context> From<&'fmt Argument<'fmt, Context>> for Arguments<'fmt, Context>

Source§

fn from(argument: &'fmt Argument<'fmt, Context>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'fmt, Context> !RefUnwindSafe for Arguments<'fmt, Context>

§

impl<'fmt, Context> !Send for Arguments<'fmt, Context>

§

impl<'fmt, Context> !Sync for Arguments<'fmt, Context>

§

impl<'fmt, Context> !UnwindSafe for Arguments<'fmt, Context>

§

impl<'fmt, Context> Freeze for Arguments<'fmt, Context>

§

impl<'fmt, Context> Unpin for Arguments<'fmt, Context>

§

impl<'fmt, Context> UnsafeUnpin for Arguments<'fmt, Context>

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<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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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, Context> MemoizeFormat<Context> for T
where T: Format<Context>,

Source§

fn memoized(self) -> Memoized<Self, Context>
where Self: Sized + Format<Context>,

Returns a formattable object that memoizes the result of Format by cloning. Mainly useful if the same sub-tree can appear twice in the formatted output because it’s used inside of if_group_breaks or if_group_fits_single_line. Read more
Source§

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

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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> 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