Enum ZoneUpdate 

#[non_exhaustive]
pub enum ZoneUpdate<R> {
    DeleteAllRecords,
    DeleteRecord(R),
    AddRecord(R),
    BeginBatchDelete(R),
    BeginBatchAdd(R),
    Finished(R),
}

Available on crate feature unstable-zonetree only.

An update to be applied to a Zone.

Design

The variants of this enum are modelled after the way the AXFR and IXFR protocols represent updates to zones.

AXFR responses can be represented as a sequence of ZoneUpdate::AddRecords.

IXFR responses can be represented as a sequence of batches, each consisting of:

• ZoneUpdate::BeginBatchDelete
• ZoneUpdate::DeleteRecords (zero or more)
• ZoneUpdate::BeginBatchAdd
• ZoneUpdate::AddRecords (zero or more)

Both AXFR and IXFR responses encoded using this enum are terminated by a final ZoneUpdate::Finished.

Use within this crate

XfrResponseInterpreter can convert received XFR responses into sequences of ZoneUpdates. These can then be consumed by a ZoneUpdater to effect changes to an existing Zone.

Future extensions

This enum is marked as #[non_exhaustive] to permit addition of more update operations in future, e.g. to support RFC 2136 Dynamic Updates operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DeleteAllRecords

Delete all records in the zone.

DeleteRecord(R)

Delete record R from the zone.

AddRecord(R)

Add record R to the zone.

BeginBatchDelete(R)

Start a batch delete for the version of the zone with the given SOA record.

If not already in batching mode, this signals the start of batching mode. In batching mode one or more batches of updates will be signalled, each consisting of the sequence:

• ZoneUpdate::BeginBatchDelete
• ZoneUpdate::DeleteRecord (zero or more)
• ZoneUpdate::BeginBatchAdd
• ZoneUpdate::AddRecord (zero or more)

Batching mode can only be terminated by UpdateComplete or UpdateIncomplete.

Batching mode makes updates more predictable for the receiver to work with by limiting the updates that can be signalled next, enabling receiver logic to be simpler and more efficient.

The record must be a SOA record that matches the SOA record of the zone version in which the subsequent ZoneUpdate::DeleteRecords should be deleted.

BeginBatchAdd(R)

Start a batch add for the version of the zone with the given SOA record.

This can only be signalled when already in batching mode, i.e. when BeginBatchDelete has already been signalled.

The record must be the SOA record to use for the new version of the zone under which the subsequent ZoneUpdate::AddRecords will be added.

See BeginBatchDelete for more information.

Finished(R)

In progress updates for the zone can now be finalized.

This signals the end of a group of related changes for the given SOA record of the zone.

For example this could be used to trigger an atomic commit of a set of related pending changes.

Trait Implementations

impl<R: Clone> Clone for ZoneUpdate<R>

fn clone(&self) -> ZoneUpdate<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for ZoneUpdate<R>

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

Formats the value using the given formatter.

impl<R> Display for ZoneUpdate<R>

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

Formats the value using the given formatter.

impl<R: Eq> Eq for ZoneUpdate<R>

impl<R: PartialEq> PartialEq for ZoneUpdate<R>

fn eq(&self, other: &ZoneUpdate<R>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<R: PartialEq> StructuralPartialEq for ZoneUpdate<R>