Shape in rustfmt_nightly::shape - Rust
Description: API documentation for the Rust `Shape` struct in crate `rustfmt_nightly`.

Skip to main content

## Shape

# Struct Shape

Source

    pub(crate) struct Shape {
        pub(crate) width: usize,
        pub(crate) indent: Indent,
        pub(crate) offset: usize,
    }

## Fields§

§`width: usize`§`indent: Indent`§`offset: usize`

## Implementations§

Source§

### impl Shape

Source

#### pub(crate) fn legacy(width: usize, indent: Indent) -> Shape

`indent` is the indentation of the first line. The next lines should begin with at least `indent` spaces (except backwards indentation). The first line should not begin with indentation. `width` is the maximum number of characters on the last line (excluding `indent`). The width of other lines is not limited by `width`. Note that in reality, we sometimes use width for lines other than the last (i.e., we are conservative).

Source

#### pub(crate) fn indented(indent: Indent, config: &Config) -> Shape

Source

#### pub(crate) fn with_max_width(&self, config: &Config) -> Shape

Source

#### pub(crate) fn visual_indent(&self, delta: usize) -> Shape

Source

#### pub(crate) fn block_indent(&self, delta: usize) -> Shape

Source

#### pub(crate) fn block_left( &self, delta: usize, span: Span, ) -> Result<Shape, ExceedsMaxWidthError>

Source

#### pub(crate) fn add_offset(&self, delta: usize) -> Shape

Source

#### pub(crate) fn block(&self) -> Shape

Source

#### pub(crate) fn saturating_sub_width(&self, delta: usize) -> Shape

Source

#### pub(crate) fn sub_width( &self, delta: usize, span: Span, ) -> Result<Shape, ExceedsMaxWidthError>

Source

#### pub(crate) fn sub_width_opt(&self, delta: usize) -> Option<Shape>

Source

#### pub(crate) fn shrink_left( &self, delta: usize, span: Span, ) -> Result<Shape, ExceedsMaxWidthError>

Source

#### pub(crate) fn shrink_left_opt(&self, delta: usize) -> Option<Shape>

Source

#### pub(crate) fn offset_left( &self, delta: usize, span: Span, ) -> Result<Shape, ExceedsMaxWidthError>

Source

#### pub(crate) fn offset_left_opt(&self, delta: usize) -> Option<Shape>

Source

#### pub(crate) fn used_width(&self) -> usize

Source

#### pub(crate) fn rhs_overhead(&self, config: &Config) -> usize

Source

#### pub(crate) fn comment(&self, config: &Config) -> Shape

Source

#### pub(crate) fn to_string_with_newline( &self, config: &Config, ) -> Cow<'static, str>

Source

#### pub(crate) fn infinite_width(&self) -> Shape

Creates a `Shape` with a virtually infinite width.

Source

#### fn exceeds_max_width_error(&self, span: Span) -> ExceedsMaxWidthError

## Trait Implementations§

Source§

### impl Clone for Shape

Source§

#### fn clone(&self) -> Shape

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for Shape

Source§

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

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

### impl Copy for Shape

## Auto Trait Implementations§

§

### impl Freeze for Shape

§

### impl RefUnwindSafe for Shape

§

### impl Send for Shape

§

### impl Sync for Shape

§

### impl Unpin for Shape

§

### impl UnsafeUnpin for Shape

§

### impl UnwindSafe for Shape

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

§

### impl<T> Instrument for T

§

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

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

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

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

### impl<T> WithSubscriber for T

§

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

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes