Skip to main content

Filesystem

Struct Filesystem 

Source
pub struct Filesystem(pub Address);
Expand description

The filesystem component (18 methods).

Provided by OpenComputers’ FileSystem.

Tuple Fields§

§0: Address

Implementations§

Source§

impl Filesystem

Source

pub fn close(&self, handle: Handle) -> Result<()>

Closes an open file descriptor with the specified handle.

Lua: filesystem.close(handle:userdata) Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn close_async(&self, handle: Handle) -> Result<()>

Self::close without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn exists(&self, path: impl AsRef<[u8]>) -> Result<bool>

Returns whether an object exists at the specified absolute path in the file system.

Lua: filesystem.exists(path:string):boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn exists_async(&self, path: impl AsRef<[u8]>) -> Result<bool>

Self::exists without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn get_label(&self) -> Result<OcString>

Get the current label of the drive.

Lua: filesystem.getLabel():string Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn get_label_async(&self) -> Result<OcString>

Self::get_label without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn is_directory(&self, path: impl AsRef<[u8]>) -> Result<bool>

Returns whether the object at the specified absolute path in the file system is a directory.

Lua: filesystem.isDirectory(path:string):boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn is_directory_async(&self, path: impl AsRef<[u8]>) -> Result<bool>

Self::is_directory without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn is_read_only(&self) -> Result<bool>

Returns whether the file system is read-only.

Lua: filesystem.isReadOnly():boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn is_read_only_async(&self) -> Result<bool>

Self::is_read_only without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn last_modified(&self, path: impl AsRef<[u8]>) -> Result<Number>

Returns the (real world) timestamp of when the object at the specified absolute path in the file system was modified.

Lua: filesystem.lastModified(path:string):number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn last_modified_async( &self, path: impl AsRef<[u8]>, ) -> Result<Number>

Self::last_modified without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn list(&self, path: impl AsRef<[u8]>) -> Result<Value>

Returns a list of names of objects in the directory at the specified absolute path in the file system.

Lua: filesystem.list(path:string):table Indirect call: waits for the next server tick.

Source

pub async fn list_async(&self, path: impl AsRef<[u8]>) -> Result<Value>

Self::list without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn make_directory(&self, path: impl AsRef<[u8]>) -> Result<bool>

Creates a directory at the specified absolute path in the file system. Creates parent directories, if necessary.

Lua: filesystem.makeDirectory(path:string):boolean Indirect call: waits for the next server tick.

Source

pub async fn make_directory_async(&self, path: impl AsRef<[u8]>) -> Result<bool>

Self::make_directory without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn open(&self, path: impl AsRef<[u8]>, mode: Option<&str>) -> Result<Handle>

Opens a new file descriptor and returns its handle.

Lua: filesystem.open(path:string[, mode:string='r']):userdata Direct call (runs immediately, drawing on the per-tick budget; OC’s limit 4). mode defaults to 'r'.

Source

pub async fn open_async( &self, path: impl AsRef<[u8]>, mode: Option<&str>, ) -> Result<Handle>

Self::open without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn read( &self, handle: Handle, count: impl Into<Number>, ) -> Result<Option<OcString>>

Reads up to the specified amount of data from an open file descriptor with the specified handle. Returns nil when EOF is reached.

Lua: filesystem.read(handle:userdata, count:number):string or nil Direct call (runs immediately, drawing on the per-tick budget; OC’s limit 15).

Source

pub async fn read_async( &self, handle: Handle, count: impl Into<Number>, ) -> Result<Option<OcString>>

Self::read without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn remove(&self, path: impl AsRef<[u8]>) -> Result<bool>

Removes the object at the specified absolute path in the file system.

Lua: filesystem.remove(path:string):boolean Indirect call: waits for the next server tick.

Source

pub async fn remove_async(&self, path: impl AsRef<[u8]>) -> Result<bool>

Self::remove without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn rename( &self, from: impl AsRef<[u8]>, to: impl AsRef<[u8]>, ) -> Result<bool>

Renames/moves an object from the first specified absolute path in the file system to the second.

Lua: filesystem.rename(from:string, to:string):boolean Indirect call: waits for the next server tick.

Source

pub async fn rename_async( &self, from: impl AsRef<[u8]>, to: impl AsRef<[u8]>, ) -> Result<bool>

Self::rename without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn seek( &self, handle: Handle, whence: impl AsRef<[u8]>, offset: impl Into<Number>, ) -> Result<Number>

Seeks in an open file descriptor with the specified handle. Returns the new pointer position.

Lua: filesystem.seek(handle:userdata, whence:string, offset:number):number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn seek_async( &self, handle: Handle, whence: impl AsRef<[u8]>, offset: impl Into<Number>, ) -> Result<Number>

Self::seek without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn set_label(&self, value: impl AsRef<[u8]>) -> Result<OcString>

Sets the label of the drive. Returns the new value, which may be truncated.

Lua: filesystem.setLabel(value:string):string Indirect call: waits for the next server tick.

Source

pub async fn set_label_async(&self, value: impl AsRef<[u8]>) -> Result<OcString>

Self::set_label without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn size(&self, path: impl AsRef<[u8]>) -> Result<Number>

Returns the size of the object at the specified absolute path in the file system.

Lua: filesystem.size(path:string):number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn size_async(&self, path: impl AsRef<[u8]>) -> Result<Number>

Self::size without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn space_total(&self) -> Result<Number>

The overall capacity of the file system, in bytes.

Lua: filesystem.spaceTotal():number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn space_total_async(&self) -> Result<Number>

Self::space_total without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn space_used(&self) -> Result<Number>

The currently used capacity of the file system, in bytes.

Lua: filesystem.spaceUsed():number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn space_used_async(&self) -> Result<Number>

Self::space_used without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Source

pub fn write(&self, handle: Handle, value: impl AsRef<[u8]>) -> Result<bool>

Writes the specified data to an open file descriptor with the specified handle.

Lua: filesystem.write(handle:userdata, value:string):boolean Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn write_async( &self, handle: Handle, value: impl AsRef<[u8]>, ) -> Result<bool>

Self::write without blocking: the call is queued, and the program keeps running until the result comes back; see crate::task.

Trait Implementations§

Source§

impl Clone for Filesystem

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Component for Filesystem

Source§

const KIND: &'static str = "filesystem"

The OpenComputers component type, such as "gpu".
Source§

fn from_address(address: Address) -> Self

Wraps an address without checking what is there.
Source§

fn address(&self) -> &Address

Source§

fn first() -> Option<Self>

The first component of this type, by address order.
Source§

fn all() -> Vec<Self>

Every component of this type, by address order.
Source§

fn at(address: impl Into<Address>) -> Option<Self>

The component at address, if it is of this type.
Source§

fn invoke(&self, method: &str, args: Vec<Value>) -> Result<Vec<Value>>

An untyped call, for methods the wrapper doesn’t know.
Source§

fn invoke_async(&self, method: &str, args: Vec<Value>) -> Call ⓘ

Component::invoke without blocking; see invoke_async.
Source§

impl Debug for Filesystem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Filesystem

Source§

impl Hash for Filesystem

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Filesystem

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Filesystem

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.