Skip to main content

FolderSizeClient

Struct FolderSizeClient 

Source
pub struct FolderSizeClient { /* private fields */ }
Available on crate feature folder only.
Expand description

Folder size client with parent directory cache.

Implementations§

Source§

impl FolderSizeClient

Source

pub const fn new() -> Self

Source

pub fn get_folder_size<'f1, 'f2, 'f3>( &'f1 mut self, path: &'f2 Path, ) -> FolderSizeClientGetFolderSizeBuilder<'f1, 'f2, 'f3>

Get the size of a folder.

See folder::size for details.

§Arguments
  • path: An absolute path to a folder

  • timeout: Optional timeout for IPC queries. If None, uses the default timeout.

  • parent_max_size: Optional mutable reference to receive the maximum size of folders in the parent folder.

    You may also want to set eager_get_links.

  • eager_get_links: If true, for folders in the parent folder with size 0, eagerly resolve symlinks/junctions and query the resolved path’s size.

§Returns
  • Ok(u64): The size in bytes
  • Err(Error): If the path is invalid

Trait Implementations§

Source§

impl Default for FolderSizeClient

Source§

fn default() -> FolderSizeClient

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more