Struct BlockTokenSecretProto

pub struct BlockTokenSecretProto {
    pub expiry_date: Option<u64>,
    pub key_id: Option<u32>,
    pub user_id: Option<String>,
    pub block_pool_id: Option<String>,
    pub block_id: Option<u64>,
    pub modes: Vec<i32>,
    pub storage_types: Vec<i32>,
    pub storage_ids: Vec<String>,
    pub handshake_secret: Option<Vec<u8>>,
}

Secret information for the BlockKeyProto. This is not sent on the wire as such but is used to pack a byte array and encrypted and put in BlockKeyProto.bytes When adding further fields, make sure they are optional as they would otherwise not be backwards compatible.

Note: As part of the migration from WritableUtils based tokens (aka “legacy”) to Protocol Buffers, we use the first byte to determine the type. If the first byte is <=0 then it is a legacy token. This means that when using protobuf tokens, the the first field sent must have a field_number less than 16 to make sure that the first byte is positive. Otherwise it could be parsed as a legacy token. See HDFS-11026 for more discussion.

Fields

expiry_date: Option<u64>

key_id: Option<u32>

user_id: Option<String>

block_pool_id: Option<String>

block_id: Option<u64>

modes: Vec<i32>

storage_types: Vec<i32>

storage_ids: Vec<String>

handshake_secret: Option<Vec<u8>>

Implementations

impl BlockTokenSecretProto

pub fn expiry_date(&self) -> u64

Returns the value of expiry_date, or the default value if expiry_date is unset.

pub fn key_id(&self) -> u32

Returns the value of key_id, or the default value if key_id is unset.

pub fn user_id(&self) -> &str

Returns the value of user_id, or the default value if user_id is unset.

pub fn block_pool_id(&self) -> &str

Returns the value of block_pool_id, or the default value if block_pool_id is unset.

pub fn block_id(&self) -> u64

Returns the value of block_id, or the default value if block_id is unset.

pub fn modes( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<AccessModeProto>>

Returns an iterator which yields the valid enum values contained in modes.

pub fn push_modes(&mut self, value: AccessModeProto)

Appends the provided enum value to modes.

pub fn storage_types( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<StorageTypeProto>>

Returns an iterator which yields the valid enum values contained in storage_types.

pub fn push_storage_types(&mut self, value: StorageTypeProto)

Appends the provided enum value to storage_types.

pub fn handshake_secret(&self) -> &[u8]

Returns the value of handshake_secret, or the default value if handshake_secret is unset.

Trait Implementations

impl Clone for BlockTokenSecretProto

fn clone(&self) -> BlockTokenSecretProto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockTokenSecretProto

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

Formats the value using the given formatter.

impl Default for BlockTokenSecretProto

fn default() -> Self

Returns the “default value” for a type.

impl Message for BlockTokenSecretProto

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BlockTokenSecretProto

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