LitStr

Struct LitStr 

Source
pub struct LitStr<'a>(pub &'a str);
Expand description

Force a YAML block literal string using the | style.

Emits the inner &str as a block scalar that preserves newlines exactly as written. Each line is indented one level deeper than the surrounding indentation where the value appears.

Behavior

  • Uses YAML’s literal block style: a leading | followed by newline.
  • Newlines are preserved verbatim by YAML consumers.
  • Indentation is handled automatically by the serializer.
  • Works in mapping values, sequence items, and at the top level.

Examples

Top-level literal block string:

let out = serde_saphyr::to_string(&serde_saphyr::LitStr("line 1\nline 2")).unwrap();
assert_eq!(out, "|\n  line 1\n  line 2\n");

As a mapping value:

use serde::Serialize;
#[derive(Serialize)]
struct S { note: serde_saphyr::LitStr<'static> }
let s = S { note: serde_saphyr::LitStr("a\nb") };
let out = serde_saphyr::to_string(&s).unwrap();
assert_eq!(out, "note: |\n  a\n  b\n");

Tuple Fields§

§0: &'a str

Trait Implementations§

Source§

impl<'a> Clone for LitStr<'a>

Source§

fn clone(&self) -> LitStr<'a>

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<'a> Serialize for LitStr<'a>

Source§

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

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

impl<'a> Copy for LitStr<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for LitStr<'a>

§

impl<'a> RefUnwindSafe for LitStr<'a>

§

impl<'a> Send for LitStr<'a>

§

impl<'a> Sync for LitStr<'a>

§

impl<'a> Unpin for LitStr<'a>

§

impl<'a> UnwindSafe for LitStr<'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> 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> 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.