Struct EncodeOptions 

pub struct EncodeOptions { /* private fields */ }

Options that control query-string encoding.

The defaults follow the common qs behavior: RFC 3986 percent-encoding, & delimiters, indexed list notation, and insertion-order output.

Implementations

impl EncodeOptions

pub fn new() -> Self

Creates a new option set with the default encode configuration.

pub fn encode(&self) -> bool

Returns whether scalar values are percent-encoded.

pub fn with_encode(self, encode: bool) -> Self

Enables or disables percent-encoding.

pub fn delimiter(&self) -> &str

Returns the delimiter inserted between encoded pairs.

pub fn with_delimiter<S>(self, delimiter: S) -> Self

where S: Into<String>,

Sets the delimiter inserted between encoded pairs.

pub fn list_format(&self) -> ListFormat

Returns the list notation used for arrays.

pub fn with_list_format(self, list_format: ListFormat) -> Self

Sets the list notation used for arrays.

pub fn format(&self) -> Format

Returns the percent-encoding flavor used for strings.

pub fn with_format(self, format: Format) -> Self

Sets the percent-encoding flavor used for strings.

pub fn charset(&self) -> Charset

Returns the character set used for percent-encoding.

pub fn with_charset(self, charset: Charset) -> Self

Sets the character set used for percent-encoding.

pub fn charset_sentinel(&self) -> bool

Returns whether a charset sentinel is prefixed to the output.

pub fn with_charset_sentinel(self, charset_sentinel: bool) -> Self

Enables or disables prepending a charset sentinel pair.

pub fn allow_empty_lists(&self) -> bool

Returns whether empty arrays are emitted.

pub fn with_allow_empty_lists(self, allow_empty_lists: bool) -> Self

Enables or disables emitting empty arrays.

pub fn strict_null_handling(&self) -> bool

Returns whether nulls are emitted without =.

pub fn with_strict_null_handling(self, strict_null_handling: bool) -> Self

Enables or disables strict null handling.

pub fn skip_nulls(&self) -> bool

Returns whether null values are omitted entirely.

pub fn with_skip_nulls(self, skip_nulls: bool) -> Self

Enables or disables omission of null values.

pub fn comma_round_trip(&self) -> bool

Returns whether single-item comma lists are round-tripped with [].

pub fn with_comma_round_trip(self, comma_round_trip: bool) -> Self

Enables or disables comma round-tripping for single-item arrays.

pub fn comma_compact_nulls(&self) -> bool

Returns whether nulls are compacted out of comma-encoded arrays.

pub fn with_comma_compact_nulls(self, comma_compact_nulls: bool) -> Self

Enables or disables null compaction for comma-encoded arrays.

pub fn encode_values_only(&self) -> bool

Returns whether only values, and not keys, are percent-encoded.

pub fn with_encode_values_only(self, encode_values_only: bool) -> Self

Enables or disables value-only percent-encoding.

pub fn add_query_prefix(&self) -> bool

Returns whether a leading ? is prefixed to the output.

pub fn with_add_query_prefix(self, add_query_prefix: bool) -> Self

Enables or disables a leading ? in the encoded output.

pub fn allow_dots(&self) -> bool

Returns whether nested object paths are encoded with dot notation.

pub fn with_allow_dots(self, allow_dots: bool) -> Self

Enables or disables dot notation during encode.

Setting this to false also clears Self::encode_dot_in_keys.

pub fn encode_dot_in_keys(&self) -> bool

Returns whether literal dots in key names are percent-encoded when dot notation is active.

pub fn with_encode_dot_in_keys(self, encode_dot_in_keys: bool) -> Self

Enables or disables percent-encoding of literal dots in keys.

Enabling this option also enables Self::allow_dots.

pub fn filter(&self) -> Option<&EncodeFilter>

Returns the configured filter, if any.

pub fn with_filter(self, filter: Option<EncodeFilter>) -> Self

Sets an optional encode filter.

pub fn whitelist(&self) -> Option<&[WhitelistSelector]>

Returns the current whitelist when EncodeFilter::Whitelist is in use.

pub fn with_whitelist(self, whitelist: Option<Vec<WhitelistSelector>>) -> Self

Replaces the current filter with a whitelist, or clears it when None is supplied.

pub fn sort(&self) -> SortMode

Returns the built-in sort mode.

pub fn with_sort(self, sort: SortMode) -> Self

Sets the built-in sort mode.

pub fn sorter(&self) -> Option<&Sorter>

Returns the custom sorter, if one is configured.

pub fn with_sorter(self, sorter: Option<Sorter>) -> Self

Sets an optional custom sorter.

pub fn encoder(&self) -> Option<&EncodeTokenEncoder>

Returns the custom key/value encoder, if one is configured.

pub fn with_encoder(self, encoder: Option<EncodeTokenEncoder>) -> Self

Sets an optional custom key/value encoder.

pub fn temporal_serializer(&self) -> Option<&TemporalSerializer>

Returns the custom temporal serializer, if one is configured.

pub fn with_temporal_serializer( self, temporal_serializer: Option<TemporalSerializer>, ) -> Self

Sets an optional custom temporal serializer.

pub fn max_depth(&self) -> Option<usize>

Returns the maximum traversal depth, if one is configured.

pub fn with_max_depth(self, max_depth: Option<usize>) -> Self

Sets the maximum traversal depth.

Trait Implementations

impl Clone for EncodeOptions

fn clone(&self) -> EncodeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodeOptions

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

Formats the value using the given formatter.

impl Default for EncodeOptions

fn default() -> Self

Returns the “default value” for a type.