Struct RenameKeyEntry

#[non_exhaustive]
pub struct RenameKeyEntry {
    pub key: String,
    pub rename_to: String,
    pub overwrite_if_exists: bool,
}

This object defines one key that will be renamed with the renameKey processor.

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.

key: String

The key to rename

rename_to: String

The string to use for the new key name

overwrite_if_exists: bool

Specifies whether to overwrite the existing value if the destination key already exists. The default is false

Implementations

impl RenameKeyEntry

pub fn key(&self) -> &str

The key to rename

pub fn rename_to(&self) -> &str

The string to use for the new key name

pub fn overwrite_if_exists(&self) -> bool

Specifies whether to overwrite the existing value if the destination key already exists. The default is false

impl RenameKeyEntry

pub fn builder() -> RenameKeyEntryBuilder

Creates a new builder-style object to manufacture RenameKeyEntry.

Trait Implementations

impl Clone for RenameKeyEntry

fn clone(&self) -> RenameKeyEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RenameKeyEntry

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

Formats the value using the given formatter.

impl PartialEq for RenameKeyEntry

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