Struct RegionRoute 

pub struct RegionRoute {
    pub region: Region,
    pub leader_peer: Option<Peer>,
    pub follower_peers: Vec<Peer>,
    pub leader_state: Option<LeaderState>,
    pub leader_down_since: Option<i64>,
    pub write_route_policy: Option<WriteRoutePolicy>,
}

Fields

region: Region

leader_peer: Option<Peer>

follower_peers: Vec<Peer>

leader_state: Option<LeaderState>

None by default.

leader_down_since: Option<i64>

The start time when the leader is in Downgraded state.

write_route_policy: Option<WriteRoutePolicy>

Special write routing behavior for this region.

Implementations

impl RegionRoute

pub fn is_ignore_all_writes(&self) -> bool

Returns true if the region should ignore all writes.

pub fn set_ignore_all_writes(&mut self)

Marks this region as ignore-all for writes.

pub fn clear_ignore_all_writes(&mut self)

Clears ignore-all write policy and falls back to normal routing behavior.

pub fn is_leader_downgrading(&self) -> bool

Returns true if the Leader Region is downgraded.

The following cases in which the Region will be downgraded.

• The Region is unavailable(e.g., Crashed, Network disconnected).
• The Region was planned to migrate to another Peer.

pub fn is_leader_staging(&self) -> bool

Returns true if the Leader Region is in staging mode.

pub fn downgrade_leader(&mut self)

Marks the Leader Region as [RegionState::Downgrading].

We should downgrade a Region before deactivating it:

• During the Region Failover Procedure.
• Migrating a Region.

Notes: Meta Server will renewing a special lease(Downgrading) for the downgrading Region.

A downgrading region will reject any write requests, and only allow memetable to be flushed to object storage

pub fn set_leader_staging(&mut self)

Sets the Leader Region to staging mode.

pub fn clear_leader_staging(&mut self)

Clears the leader staging state, returning to normal leader mode.

pub fn leader_down_millis(&self) -> Option<i64>

Returns how long since the leader is in Downgraded state.

pub fn set_leader_state(&mut self, state: Option<LeaderState>) -> bool

Sets the leader state.

Returns true if updated.

Trait Implementations

impl Clone for RegionRoute

fn clone(&self) -> RegionRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegionRoute

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

Formats the value using the given formatter.

impl Default for RegionRoute

fn default() -> RegionRoute

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegionRoute

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RegionRoute

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RegionRoute