Struct RiFile System &nbsp; Copy item path

impl RiFileSystem

pub fn new_with_root(project_root: PathBuf) -> Self

Creates a new file system with a project root and default app data root.

§Parameters

project_root: The project root directory

§Returns

A new RiFileSystem instance

pub fn new_with_roots(project_root: PathBuf, app_data_root: PathBuf) -> Self

Creates a new file system with specified roots.

§Parameters

project_root: The project root directory
app_data_root: The application data root directory

§Returns

A new RiFileSystem instance

pub fn new_auto_root() -> RiResult<Self>

Creates a new file system with the current working directory as the project root.

§Returns

A RiResult<Self> containing the new RiFileSystem instance

pub fn project_root(&self) -> &Path

Returns the project root directory.

§Returns

A reference to the project root path

pub fn safe_mkdir<P: AsRef<Path>>(&self, path: P) -> RiResult<PathBuf>

Safely creates a directory and all its parent directories if they don’t exist.

§Parameters

path: The path to the directory to create

§Returns

A RiResult<PathBuf> containing the created directory path

pub fn ensure_parent_dir<P: AsRef<Path>>(&self, path: P) -> RiResult<PathBuf>

Ensures that the parent directory of a given path exists.

§Parameters

path: The path whose parent directory should be ensured

§Returns

A RiResult<PathBuf> containing the parent directory path

pub fn atomic_write_text<P: AsRef<Path>>( &self, path: P, text: &str, ) -> RiResult<()>

Atomically writes text to a file.

This method writes to a temporary file first, then renames it to the target path, ensuring that the write operation is atomic.

§Parameters

path: The path to the file to write
text: The text to write to the file

§Returns

A RiResult<()> indicating success or failure

pub fn atomic_write_bytes<P: AsRef<Path>>( &self, path: P, data: &[u8], ) -> RiResult<()>

Atomically writes bytes to a file.

This method writes to a temporary file first, then renames it to the target path, ensuring that the write operation is atomic.

§Parameters

path: The path to the file to write
data: The bytes to write to the file

§Returns

A RiResult<()> indicating success or failure

pub fn read_text<P: AsRef<Path>>(&self, path: P) -> RiResult<String>

Reads text from a file.

§Parameters

path: The path to the file to read

§Returns

A RiResult<String> containing the file content

pub fn read_json<P: AsRef<Path>, T: DeserializeOwned>( &self, path: P, ) -> RiResult<T>

Reads JSON from a file and deserializes it into a type.

§Parameters

path: The path to the JSON file to read

§Type Parameters

T: The type to deserialize the JSON into

§Returns

A RiResult<T> containing the deserialized data

pub fn exists<P: AsRef<Path>>(&self, path: P) -> bool

Checks if a file or directory exists.

§Parameters

path: The path to check

§Returns

true if the path exists, false otherwise

pub fn remove_file<P: AsRef<Path>>(&self, path: P) -> RiResult<()>

Removes a file.

§Parameters

path: The path to the file to remove

§Returns

A RiResult<()> indicating success or failure

pub fn remove_dir_all<P: AsRef<Path>>(&self, path: P) -> RiResult<()>

Removes a directory and all its contents.

§Parameters

path: The path to the directory to remove

§Returns

A RiResult<()> indicating success or failure

pub fn copy_file<P: AsRef<Path>, Q: AsRef<Path>>( &self, from: P, to: Q, ) -> RiResult<()>

Copies a file from one path to another.

§Parameters

from: The source file path
to: The destination file path

§Returns

A RiResult<()> indicating success or failure

pub fn append_text<P: AsRef<Path>>(&self, path: P, text: &str) -> RiResult<()>

Appends text to a file.

§Parameters

path: The path to the file to append to
text: The text to append to the file

§Returns

A RiResult<()> indicating success or failure

pub fn write_json<P: AsRef<Path>, T: Serialize>( &self, path: P, value: &T, ) -> RiResult<()>

Writes a JSON value to a file.

§Parameters

path: The path to the file to write
value: The value to serialize and write

§Type Parameters

T: The type of the value to serialize

§Returns

A RiResult<()> indicating success or failure

pub fn app_dir(&self) -> PathBuf

Returns the application data directory.

§Returns

The application data directory path

pub fn logs_dir(&self) -> PathBuf

Returns the logs directory.

§Returns

The logs directory path

pub fn cache_dir(&self) -> PathBuf

Returns the cache directory.

§Returns

The cache directory path

pub fn reports_dir(&self) -> PathBuf

Returns the reports directory.

§Returns

The reports directory path

pub fn observability_dir(&self) -> PathBuf

Returns the observability directory.

§Returns

The observability directory path

pub fn temp_dir(&self) -> PathBuf

Returns the temporary directory.

§Returns

The temporary directory path

pub fn ensure_category_path<S: AsRef<str>, P: AsRef<Path>>( &self, category: S, path_or_name: P, ) -> PathBuf

Ensures a path exists under a specific category directory.

§Parameters

category: The category name (“logs”, “cache”, “reports”, “observability”, “tmp”, or other)
path_or_name: The path or name to ensure under the category directory

§Returns

The full path to the ensured file or directory

pub fn normalize_under_category<S: AsRef<str>, P: AsRef<Path>>( &self, category: S, path_or_name: P, ) -> PathBuf

Normalizes a path under a specific category directory, using only the file name.

§Parameters

category: The category name (“logs”, “cache”, “reports”, “observability”, “tmp”, or other)
path_or_name: The path or name to normalize

§Returns

The full path to the normalized file or directory

Trait Implementations§

impl Clone for RiFileSystem

fn clone(&self) -> RiFileSystem

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'py> IntoPyObject<'py> for RiFileSystem

type Target = RiFileSystem

The Python output type

type Output = Bound<'py, <RiFileSystem as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiFileSystem

type Frozen = False

Whether the pyclass is frozen. Read more

impl PyClassImpl for RiFileSystem

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Public-facing filesystem class.\n\nThis struct provides a comprehensive file system abstraction for Ri, offering safe and reliable\nfile operations with support for atomic writes, directory management, and structured data formats.\x00"

Docstring for the class provided on the struct or enum. Read more

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiFileSystem>

This handles following two situations: Read more

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

const NAME: &'static str = "RiFileSystem"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for RiFileSystem

impl ExtractPyClassWithClone for RiFileSystem

Auto Trait Implementations§

impl Freeze for RiFileSystem

impl RefUnwindSafe for RiFileSystem

impl Send for RiFileSystem

impl Sync for RiFileSystem

impl Unpin for RiFileSystem

impl UnsafeUnpin for RiFileSystem

impl UnwindSafe for RiFileSystem

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<'a, 'py, T> FromPyObject<'a, 'py> for T
where T: PyClass + Clone + ExtractPyClassWithClone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<T, <T as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj. Read more

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.

Name of self. This is used in error messages, for example.