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 strTrait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more