Struct gmime::FormatOptions

pub struct FormatOptions(_);

Format options for serializing various GMime objects.

Methods

impl FormatOptions

pub fn new() -> FormatOptions

Creates a new set of FormatOptions.

Returns

a newly allocated set of FormatOptions with the default values.

pub fn add_hidden_header(&mut self, header: &str)

Adds the given header to the list of headers that should be hidden.

header

a header name

pub fn clear_hidden_headers(&mut self)

Clears the list of headers that should be hidden.

pub fn clone(&mut self) -> Option<FormatOptions>

Clones a FormatOptions.

Returns

a newly allocated FormatOptions.

pub fn create_newline_filter(&mut self, ensure_newline: bool) -> Option<Filter>

Creates a Filter suitable for converting line-endings to the currently set new-line format.

ensure_newline

true if the output must always end with a new line

Returns

a Filter to convert to the specified new-line format.

pub fn get_newline(&mut self) -> Option<String>

Gets a string representing the currently set new-line format.

Returns

a new-line character sequence.

pub fn get_newline_format(&mut self) -> NewLineFormat

Gets the new-line format to use when writing out messages and headers.

Returns

the new-line format that is currently set.

pub fn get_param_encoding_method(&mut self) -> ParamEncodingMethod

Gets the parameter encoding method to use for Param parameters that do not already have an encoding method specified.

Returns

the encoding method that is currently set.

pub fn is_hidden_header(&mut self, header: &str) -> bool

Gets whether or not the specified header should be hidden.

header

the name of a header

Returns

true if the header should be hidden or false otherwise.

pub fn remove_hidden_header(&mut self, header: &str)

Removes the given header from the list of headers that should be hidden.

header

a header name

pub fn set_newline_format(&mut self, newline: NewLineFormat)

Sets the new-line format that should be used when writing headers and messages.

newline

a NewLineFormat

pub fn set_param_encoding_method(&mut self, method: ParamEncodingMethod)

Sets the parameter encoding method to use when encoding parameters which do not have an encoding method specified.

Note: ParamEncodingMethod::Default is not allowed.

method

a ParamEncodingMethod

pub fn get_default() -> Option<FormatOptions>

Gets the default format options.

Returns

the default format options.

Trait Implementations

impl Clone for FormatOptions

fn clone(&self) -> FormatOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FormatOptions

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl StaticType for FormatOptions

fn static_type() -> Type

Returns the type identifier of Self.

impl Default for FormatOptions

fn default() -> Self

Returns the "default value" for a type.