Struct RenderOptions 

#[non_exhaustive]
pub struct RenderOptions {
    pub include_bcc: bool,
    pub soft_fold_at: Option<usize>,
}

Render-time options for render_rfc822_with.

The struct is #[non_exhaustive]; future fields will be additive. Construct via Self::new or Self::default and chain with_* setters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include_bcc: bool

When true, the rendered message includes a Bcc: header line listing the message’s BCC recipients. Defaults to false.

Most SMTP relays strip Bcc: on submission anyway; rendering the field is occasionally useful for archival, .eml fixtures, or clients that consume the rendered bytes outside the SMTP path.

soft_fold_at: Option<usize>

Optional soft-fold target for header lines, in characters.

None (the default) emits header lines at the RFC 5322 §2.1.1 hard limit of 998 characters with no soft folding, long values flow on a single physical line. Some(n) instructs the renderer to fold longer lines at n characters via the standard folding-whitespace mechanism (CRLF + leading SP/HTAB), targeting the SHOULD ≤ 78 recommendation when n == 78.

The default is None because correct soft folding requires per-header-grammar awareness (encoded-word boundaries, address-list comma discipline, structured-header whitespace rules) that the simple folding helper cannot guarantee in every case. Callers who want SHOULD-compliant output for archival or for strict legacy MTAs can opt in via with_soft_fold(78); the renderer still respects the 998 hard limit regardless.

Implementations

impl RenderOptions

pub const fn new() -> Self

pub const fn with_include_bcc(self, value: bool) -> Self

pub const fn with_soft_fold(self, soft_fold_at: usize) -> Self

Set the soft-fold target. Pass 78 for the RFC 5322 §2.1.1 SHOULD-compliant recommendation; pass any other positive integer up to 997 for a custom target.

pub const fn without_soft_fold(self) -> Self

Disable soft folding. Long header values flow on one physical line up to the 998-character hard limit.

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> RenderOptions

Returns the “default value” for a type.

impl PartialEq for RenderOptions

fn eq(&self, other: &RenderOptions) -> 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 Copy for RenderOptions

impl Eq for RenderOptions

impl StructuralPartialEq for RenderOptions