Struct QuoteOptionsBuilder 

pub struct QuoteOptionsBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> QuoteOptionsBuilder<S>

pub fn build(self) -> QuoteOptions

where S: IsComplete,

Finish building and return the requested object

pub fn always_quote(self, value: bool) -> QuoteOptionsBuilder<SetAlwaysQuote<S>>

where S::AlwaysQuote: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to quote the input even if nothing in it needs quoting.

pub fn maybe_always_quote( self, value: Option<bool>, ) -> QuoteOptionsBuilder<SetAlwaysQuote<S>>

where S::AlwaysQuote: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to quote the input even if nothing in it needs quoting.

pub fn preferred_mode( self, value: QuoteMode, ) -> QuoteOptionsBuilder<SetPreferredMode<S>>

where S::PreferredMode: IsUnset,

Optional (Some / Option setters). Default: <QuoteMode as Default>::default().

Preferred mode for quoting. It’s upgraded to ANSI-C quoting ($'...') if the input has chars only that can express.

pub fn maybe_preferred_mode( self, value: Option<QuoteMode>, ) -> QuoteOptionsBuilder<SetPreferredMode<S>>

where S::PreferredMode: IsUnset,

Optional (Some / Option setters). Default: <QuoteMode as Default>::default().

Preferred mode for quoting. It’s upgraded to ANSI-C quoting ($'...') if the input has chars only that can express.

pub fn avoid_ansi_c_quoting_newline( self, value: bool, ) -> QuoteOptionsBuilder<SetAvoidAnsiCQuotingNewline<S>>

where S::AvoidAnsiCQuotingNewline: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to avoid ANSI-C quoting just for newlines, which otherwise require it.

pub fn maybe_avoid_ansi_c_quoting_newline( self, value: Option<bool>, ) -> QuoteOptionsBuilder<SetAvoidAnsiCQuotingNewline<S>>

where S::AvoidAnsiCQuotingNewline: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to avoid ANSI-C quoting just for newlines, which otherwise require it.

pub fn leave_leading_hash( self, value: bool, ) -> QuoteOptionsBuilder<SetLeaveLeadingHash<S>>

where S::LeaveLeadingHash: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to leave a # starting the input unquoted. Bash does in some output that isn’t read back as shell input, e.g. tracing a [[ -n ... ]] test.

pub fn maybe_leave_leading_hash( self, value: Option<bool>, ) -> QuoteOptionsBuilder<SetLeaveLeadingHash<S>>

where S::LeaveLeadingHash: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to leave a # starting the input unquoted. Bash does in some output that isn’t read back as shell input, e.g. tracing a [[ -n ... ]] test.

pub fn leave_tilde(self, value: bool) -> QuoteOptionsBuilder<SetLeaveTilde<S>>

where S::LeaveTilde: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to leave a ~ unquoted where it would be tilde-expanded. Bash does when quoting a file name it completes, so that a ~user completion still expands.

pub fn maybe_leave_tilde( self, value: Option<bool>, ) -> QuoteOptionsBuilder<SetLeaveTilde<S>>

where S::LeaveTilde: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to leave a ~ unquoted where it would be tilde-expanded. Bash does when quoting a file name it completes, so that a ~user completion still expands.

pub fn quote_commas(self, value: bool) -> QuoteOptionsBuilder<SetQuoteCommas<S>>

where S::QuoteCommas: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to quote commas, which aren’t special on their own. Bash’s printf %q does, so its output is safe even inside a brace expansion.

pub fn maybe_quote_commas( self, value: Option<bool>, ) -> QuoteOptionsBuilder<SetQuoteCommas<S>>

where S::QuoteCommas: IsUnset,

Optional (Some / Option setters). Default: false.

Whether to quote commas, which aren’t special on their own. Bash’s printf %q does, so its output is safe even inside a brace expansion.