CommentRewrite in rustfmt_nightly::comment - Rust
Description: API documentation for the Rust `CommentRewrite` struct in crate `rustfmt_nightly`.

Skip to main content

## CommentRewrite

# Struct CommentRewrite

Source

    struct CommentRewrite<'a> {Show 14 fields
        result: String,
        code_block_buffer: String,
        is_prev_line_multi_line: bool,
        code_block_attr: Option<CodeBlockAttribute>,
        item_block: Option<ItemizedBlock>,
        comment_line_separator: String,
        indent_str: String,
        max_width: usize,
        fmt_indent: Indent,
        fmt: StringFormat<'a>,
        opener: String,
        closer: String,
        line_start: String,
        style: CommentStyle<'a>,
    }

## Fields§

§`result: String`§`code_block_buffer: String`§`is_prev_line_multi_line: bool`§`code_block_attr: Option<CodeBlockAttribute>`§`item_block: Option<ItemizedBlock>`§`comment_line_separator: String`§`indent_str: String`§`max_width: usize`§`fmt_indent: Indent`§`fmt: StringFormat<'a>`§`opener: String`§`closer: String`§`line_start: String`§`style: CommentStyle<'a>`

## Implementations§

Source§

### impl<'a> CommentRewrite<'a>

Source

#### fn new( orig: &'a str, block_style: bool, shape: Shape, config: &'a Config, ) -> CommentRewrite<'a>

Source

#### fn join_block(s: &str, sep: &str) -> String

Source

#### fn buffer_contains_comment(&self) -> bool

Check if any characters were written to the result buffer after the start of the comment. when calling `CommentRewrite::new()` the result buffer is initialized with the opening characters for the comment.

Source

#### fn finish(self) -> String

Source

#### fn handle_line( &mut self, orig: &'a str, i: usize, line: &'a str, has_leading_whitespace: bool, is_doc_comment: bool, ) -> bool

## Auto Trait Implementations§

§

### impl<'a> Freeze for CommentRewrite<'a>

§

### impl<'a> !RefUnwindSafe for CommentRewrite<'a>

§

### impl<'a> !Send for CommentRewrite<'a>

§

### impl<'a> !Sync for CommentRewrite<'a>

§

### impl<'a> Unpin for CommentRewrite<'a>

§

### impl<'a> UnsafeUnpin for CommentRewrite<'a>

§

### impl<'a> !UnwindSafe for CommentRewrite<'a>

## 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> 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, 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: 416 bytes