Enum LineEnding 

pub enum LineEnding {
    CarriageReturnLineFeed,
    CarriageReturn,
    LineFeed,
}

Type of line endings in markdown.

Particularly when working with Windows, you might want to use LineEnding::CarriageReturnLineFeed.

Examples

use socketry_markdown::LineEnding;

// Use a CR + LF combination:
let crlf = LineEnding::CarriageReturnLineFeed;

Variants

CarriageReturnLineFeed

Both a carriage return (\r) and a line feed (\n).

Example

a␍␊
b

CarriageReturn

Sole carriage return (\r).

Example

a␍
b

LineFeed

Sole line feed (\n).

Example

a␊
b

Implementations

impl LineEnding

pub fn as_str(&self) -> &str

Turn the line ending into a str.

Trait Implementations

impl Clone for LineEnding

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LineEnding

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

Formats the value using the given formatter.

impl Default for LineEnding

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LineEnding

impl FromStr for LineEnding

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

Turn a string into a line ending.

Panics

Panics if code is not \r\n, \r, or \n.

type Err = String

The associated error which can be returned from parsing.

impl PartialEq for LineEnding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LineEnding