Skip to main content

MultilineStyle

Enum MultilineStyle 

Source
#[non_exhaustive]
pub enum MultilineStyle { Floating, Bold, BoldFloating, Transparent, Light, FoldingQuotes, }
Expand description

Controls which multiline string format is preferred when rendering strings with newlines.

Only affects strings that contain at least one EOL (LF or CRLF). Single-line strings always follow the normal bare_strings / string_quoted_fold_style options.

  • Bold (``, default): double backtick, body always at col 2. Always safe.
  • Floating (`): single backtick, body at n+2. Falls back to Bold when any content line would overflow wrap_width at that indent, or when the string exceeds multiline_max_lines, or when content is pipe-heavy / backtick-starting.
  • BoldFloating (``): double backtick, body at n+2 when it fits, col 2 when it overflows.
  • Transparent (```): triple backtick, body at col 0. Falls back to Bold when content is pipe-heavy or has backtick-starting lines (visually unsafe in that format).
  • Light (` or ``): prefers `; falls back to `` like Floating, but the fallback reason differs — see variant doc for details.
  • FoldingQuotes (JSON string with / folds): never uses any multiline string format. Renders EOL-containing strings as folded JSON strings. When the encoded string is within 25 % of wrap_width from fitting, it is emitted unfolded (overrunning the limit is preferred over a fold that saves almost nothing).

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

Floating

` with body at n+2; falls back to Bold on overflow or excessive length.

§

Bold

`` with body always at col 2.

§

BoldFloating

`` with body at n+2 when it fits, col 2 when any line overflows wrap_width.

§

Transparent

``` with body at col 0; falls back to Bold when content is pipe-heavy or starts with backtick characters. string_multiline_fold_style has no effect here — / continuations are not allowed inside triple-backtick blocks.

§

Light

` preferred; falls back to `` only when content looks like TJSON markers (pipe-heavy or backtick-starting lines). Width overflow and line count do NOT trigger fallback — a long ` is preferred over the heavier `` format.

§

FoldingQuotes

Always a JSON string for EOL-containing strings; folds with / to fit wrap_width unless the overrun is within 25 % of wrap_width.

Trait Implementations§

Source§

impl Clone for MultilineStyle

Source§

fn clone(&self) -> MultilineStyle

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 MultilineStyle

Source§

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

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

impl Default for MultilineStyle

Source§

fn default() -> MultilineStyle

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for MultilineStyle

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

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

impl FromStr for MultilineStyle

Source§

type Err = String

The associated error which can be returned from parsing.
Source§

fn from_str(input: &str) -> Result<Self, Self::Err>

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

impl PartialEq for MultilineStyle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MultilineStyle

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for MultilineStyle

Source§

impl Eq for MultilineStyle

Source§

impl StructuralPartialEq for MultilineStyle

Auto Trait Implementations§

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<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, 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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,