Struct cannyls::block::BlockSize

pub struct BlockSize(_);

StorageやNonVolatileMemoryのブロックサイズを表現するための構造体.

"ブロック"は、I/Oの最小単位であり、読み書き対象の領域およびその際に使用するバッファは、 BlockSizeによって指定された境界にアライメントされている必要がある.

指定されたサイズのブロック境界にアライメントを行うための補助メソッド群も提供している.

Methods

impl BlockSize

pub const MIN: u16

許容されるブロックサイズの最小値.

全てのブロックサイズは、この値の倍数である必要がある.

またBlockSize::default()で使われる値でもある.

pub fn min() -> Self

許容可能な最小のブロックサイズを持つBlockSizeインスタンスを返す.

Examples

use cannyls::block::BlockSize;

assert_eq!(BlockSize::min().as_u16(), BlockSize::MIN);

pub fn new(block_size: u16) -> Result<Self>

指定された値のブロックサイズを表現するBlockSizeインスタンスを生成する.

Errors

以下の場合には、種類がErrorKind::InvalidInputのエラーが返される:

• block_sizeがBlockSize::MIN未満
• block_sizeがBlockSize::MINの倍数ではない

Examples

use cannyls::ErrorKind;
use cannyls::block::BlockSize;

assert_eq!(BlockSize::new(512).ok().map(|a| a.as_u16()), Some(512));
assert_eq!(BlockSize::new(4096).ok().map(|a| a.as_u16()), Some(4096));

assert_eq!(BlockSize::new(256).err().map(|e| *e.kind()), Some(ErrorKind::InvalidInput));
assert_eq!(BlockSize::new(513).err().map(|e| *e.kind()), Some(ErrorKind::InvalidInput));

pub fn ceil_align(self, position: u64) -> u64

指定位置より後方の最初のブロックサイズ位置を返す.

Examples

use cannyls::block::BlockSize;

let block_size = BlockSize::new(512).unwrap();
assert_eq!(block_size.ceil_align(0), 0);
assert_eq!(block_size.ceil_align(1), 512);
assert_eq!(block_size.ceil_align(512), 512);

pub fn floor_align(self, position: u64) -> u64

指定位置より前方の最初のブロックサイズ位置を返す.

Examples

use cannyls::block::BlockSize;

let block_size = BlockSize::new(512).unwrap();
assert_eq!(block_size.floor_align(0), 0);
assert_eq!(block_size.floor_align(1), 0);
assert_eq!(block_size.floor_align(512), 512);

pub fn as_u16(self) -> u16

ブロックサイズ値をu16に変換して返す.

pub fn contains(self, other: BlockSize) -> bool

このブロックサイズがotherを包含しているかを確認する.

"包含している"とは「selfのブロックサイズがotherのブロックサイズの倍数」であることを意味する.

Examples

use cannyls::block::BlockSize;

let block_size = BlockSize::new(2048).unwrap();
assert!(block_size.contains(BlockSize::new(512).unwrap()));
assert!(block_size.contains(BlockSize::new(1024).unwrap()));
assert!(!block_size.contains(BlockSize::new(1536).unwrap()));

pub fn is_aligned(self, position: u64) -> bool

指定位置がブロックサイズ境界に沿っているかどうかを判定する.

Examples

use cannyls::block::BlockSize;

let block_size = BlockSize::new(512).unwrap();
assert!(block_size.is_aligned(0));
assert!(block_size.is_aligned(512));
assert!(block_size.is_aligned(1024));

assert!(!block_size.is_aligned(511));
assert!(!block_size.is_aligned(513));

Trait Implementations

impl Clone for BlockSize

fn clone(&self) -> BlockSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BlockSize

impl Debug for BlockSize

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

Formats the value using the given formatter.

impl Default for BlockSize

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BlockSize

impl Hash for BlockSize

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for BlockSize

fn cmp(&self, other: &BlockSize) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BlockSize> for BlockSize

fn eq(&self, other: &BlockSize) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BlockSize> for BlockSize

fn partial_cmp(&self, other: &BlockSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BlockSize) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BlockSize) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BlockSize) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BlockSize) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for BlockSize

impl StructuralPartialEq for BlockSize