Trait bao_tree::io::sync::Size

pub trait Size {
    // Required method
    fn size(&self) -> Result<Option<u64>, Error>;
}

Trait to get the size in bytes of an I/O object.

Implementing this for a types with ReadAt or WriteAt makes it easier for users to predict whether they will read past end-of-file. However, it may not be possible to implement for certain readers or writers that have unknown size.

Examples

use std::fs::File;
use positioned_io::Size;

let file = File::open("tests/pi.txt")?;
let size = file.size()?;
assert_eq!(size, Some(1000002));

// some special files do not have a known size
let file = File::open("/dev/stdin")?;
let size = file.size()?;
assert_eq!(size, None);

Required Methods

fn size(&self) -> Result<Option<u64>, Error>

Get the size of this object, in bytes.

This function may return Ok(None) if the size is unknown, for example for pipes.

Implementations on Foreign Types

impl<'a, S> Size for &'a mut Swhere S: Size + ?Sized,

fn size(&self) -> Result<Option<u64>, Error>

impl<'a, S> Size for &'a RefCell<S>where S: Size,

fn size(&self) -> Result<Option<u64>, Error>

impl<'a, S> Size for &'a Swhere S: Size + ?Sized,

fn size(&self) -> Result<Option<u64>, Error>

impl<'a> Size for &'a [u8]

fn size(&self) -> Result<Option<u64>, Error>

impl Size for Vec<u8, Global>

fn size(&self) -> Result<Option<u64>, Error>

impl Size for File

fn size(&self) -> Result<Option<u64>, Error>

impl<'a> Size for &'a mut [u8]

fn size(&self) -> Result<Option<u64>, Error>

Implementors

impl<I> Size for Slice<I>