Struct LineWrap 

pub struct LineWrap {
    pub line_len: usize,
    pub line_ending: LineEnding,
}

Base64 line wrapping policy.

line_len is measured in encoded Base64 bytes, not source input bytes. Encoders insert line endings between lines and do not append a trailing line ending after the final line.

Fields

line_len: usize

Maximum encoded bytes per line.

line_ending: LineEnding

Line ending inserted between wrapped lines.

Implementations

impl LineWrap

pub const MIME: Self

MIME-style wrapping: 76 columns with CRLF endings.

pub const PEM: Self

PEM-style wrapping: 64 columns with LF endings.

pub const PEM_CRLF: Self

PEM-style wrapping: 64 columns with CRLF endings.

pub const fn new(line_len: usize, line_ending: LineEnding) -> Self

Creates a wrapping policy.

This constructor is intended for fixed, trusted values such as compile-time MIME or PEM profile constants. Use Self::checked_new when the line length comes from configuration, network input, file metadata, or another untrusted runtime source.

Panics

Panics when line_len is zero. Base64 wrapping requires a non-zero encoded line length; accepting zero would make progress impossible for wrapped encoders. This constructor is callable at runtime, so do not pass attacker-controlled or externally configured values here; use Self::checked_new for those cases.

pub const fn checked_new( line_len: usize, line_ending: LineEnding, ) -> Option<Self>

Creates a wrapping policy, returning None when the line length is invalid.

Base64 line-wrapping requires a non-zero encoded line length. This helper is useful when accepting a wrapping policy from configuration or another untrusted source.

pub const fn line_len(self) -> usize

Returns the maximum encoded bytes per line.

pub const fn line_ending(self) -> LineEnding

Returns the line ending inserted between wrapped lines.

pub const fn is_valid(self) -> bool

Returns whether this wrapping policy can be used by the encoder.

Trait Implementations

impl Clone for LineWrap

fn clone(&self) -> LineWrap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LineWrap

impl Debug for LineWrap

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

Formats the value using the given formatter.

impl Display for LineWrap

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

Formats the value using the given formatter.

impl Eq for LineWrap

impl PartialEq for LineWrap

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for LineWrap