Indent

Struct Indent 

Source
pub struct Indent<T>(pub T);
Expand description

A wrapper which indents any newlines inside its contents.

§Examples

Basic usage:

use pretty_trait::{JoinExt, Sep, Indent, to_string};

let max_line = Some(20);
let tab_size = 4;

let expected = "\
(
    lorem
    ipsum
    dolor
    sit
    amet
)";

assert_eq!(
    to_string(
        &"(".join(Indent(
            Sep(0)
                .join("lorem")
                .join(Sep(1))
                .join("ipsum")
                .join(Sep(1))
                .join("dolor")
                .join(Sep(1))
                .join("sit")
                .join(Sep(1))
                .join("amet")
        )).join(Sep(0)).join(")"),
        max_line,
        tab_size,
    ),
    expected
);

§Caution

To indent a block enclosed in paired delimiters like brackets, care must be taken to ensure that the first line of the content is indented, and that the closing delimiter is not indented along with its contents. To ensure this, the newline after the opening delimiter should occur inside the Indent block, and the newline before the closing delimiter should occur outside the Indent block, as in the example above. The block function implements this pattern.

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<T: Clone> Clone for Indent<T>

Source§

fn clone(&self) -> Indent<T>

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<T: Debug> Debug for Indent<T>

Source§

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

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

impl<T: Pretty> Pretty for Indent<T>

Source§

fn size(&self) -> Size

Calculate the intrinsic size of this value, if it were to be displayed on a single line.
Source§

fn pretty_write(&self, context: Context<'_>) -> Result<()>

Render this value in a given context.
Source§

impl<T: Copy> Copy for Indent<T>

Auto Trait Implementations§

§

impl<T> Freeze for Indent<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Indent<T>
where T: RefUnwindSafe,

§

impl<T> Send for Indent<T>
where T: Send,

§

impl<T> Sync for Indent<T>
where T: Sync,

§

impl<T> Unpin for Indent<T>
where T: Unpin,

§

impl<T> UnwindSafe for Indent<T>
where T: UnwindSafe,

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, 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> JoinExt for T
where T: Pretty,

Source§

fn join<U>(self, other: U) -> Join<T, U>

Concatenate two pretty-printable values. This directly displays one after the other, with no separation or line breaks. For separation, use the Sep type. 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.