Struct Scope

pub struct Scope<T> { /* private fields */ }

Handle to a DebugFS scope, which ensures that attached data will outlive the DebugFS entry without moving.

This is internally used to back File, and used in the API to represent the attachment of a directory lifetime to a data structure which may be jointly accessed by a number of different files.

When dropped, a Scope will remove all directories and files in the filesystem backed by the attached data structure prior to releasing the attached data.

Implementations

impl<T> Scope<T>

pub fn project<'__pin>( self: Pin<&'__pin mut Self>, ) -> ScopeProjection<'__pin, T>

Pin-projects all fields of Self.

These fields are structurally pinned:

• data
• _pin

These fields are not structurally pinned:

• _entry

impl<'a, T: 'a> Scope<T>

pub fn dir<E: 'a, F>( data: impl PinInit<T, E> + 'a, name: &'a CStr, init: F, ) -> impl PinInit<Self, E> + 'a

where F: for<'data, 'dir> FnOnce(&'data T, &'dir ScopedDir<'data, 'dir>) + 'a,

Creates a new scope, which is a directory at the root of the debugfs filesystem, associated with some data T.

The init closure is called to populate the directory with files and subdirectories. These files can reference the data stored in the scope.

The entire directory tree created within the scope will be removed when the returned Scope handle is dropped.

Trait Implementations

impl<T> Deref for Scope<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> HasPinData for Scope<T>

type PinData = __ThePinData<T>

unsafe fn __pin_data() -> Self::PinData