Struct veloren_server::settings::banlist::IpBanEntry

pub struct IpBanEntry {
    pub current: IpBanRecord,
    pub history: Vec<IpBanRecord>,
    pub expired: bool,
}

NOTE: Always replace this with the latest banlist version. Then update the BanlistRaw, the TryFrom for Banlist, the previously most recent module, and add a new module for the latest version! Please respect the migration upgrade guarantee found in the parent module with any upgrade.

Fields

current: IpBanRecord

The latest ban record for this IP.

Note: If this IP is currently banned and the current BanRecord contains a Uuid, then this user must also be banned in the Uuid ban map. This is enforced by the validation.

history: Vec<IpBanRecord>

Historical ban records for this user, stored in order from oldest to newest.

expired: bool

A hint about whether the system thinks this entry is expired, mostly to make it easier for someone manually going through a file to see whether an entry is currently in effect or not. This is based off the contents of current.

Implementations

impl IpBanEntry

fn validate( &mut self, now: DateTime<Utc>, uuid_bans: &HashMap<Uuid, BanEntry>, ) -> Result<Version, <Banlist as EditableSetting>::Error>

Both validates, and updates the hint bit if it’s inconsistent with reality.

If we were invalid, returns an error. Otherwise, returns Ok(v), where v is Latest if the hint bit was modified, Old otherwise.

Methods from Deref<Target = IpBanRecord>

fn is_expired(&self, now: DateTime<Utc>) -> bool

Returns true if this record represents an expired ban, false otherwise.

fn validate( &self, prev_record: Option<&IpBanRecord>, ) -> Result<(), BanErrorKind>

The history vector in a IpBanEntry is stored forwards (from oldest entry to newest), so prev_record is the previous entry in this vector when iterating forwards (by array index).

Errors are:

AlreadyUnbanned if an unban comes after anything but a ban.

Permission(Unban) if an unban attempt is by a user with a lower role level than the original banning party.

PermissionDenied(Ban) if a ban length is made shorter by a user with a role level than the original banning party.

InvalidDateRange if the end date of the ban exceeds the start date.

Trait Implementations

impl Clone for IpBanEntry

fn clone(&self) -> IpBanEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for IpBanEntry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IpBanEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Deref for IpBanEntry

type Target = IpBanRecord

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.