Skip to main content

Drive

Struct Drive 

Source
pub struct Drive(pub Address);
Expand description

The drive component (9 methods).

Provided by OpenComputers’ Drive.

Tuple Fields§

§0: Address

Implementations§

Source§

impl Drive

Source

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

Returns the total capacity of the drive, in bytes.

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

Source

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

Self::get_capacity 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: drive.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 get_platter_count(&self) -> Result<Number>

Returns the number of platters in the drive.

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

Source

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

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

Source

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

Returns the size of a single sector on the drive, in bytes.

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

Source

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

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

Source

pub fn read_byte(&self, offset: impl Into<Number>) -> Result<Number>

Read a single byte at the specified offset.

Lua: drive.readByte(offset:number):number Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn read_byte_async(&self, offset: impl Into<Number>) -> Result<Number>

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

Source

pub fn read_sector(&self, sector: impl Into<Number>) -> Result<OcString>

Read the current contents of the specified sector.

Lua: drive.readSector(sector:number):string Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn read_sector_async( &self, sector: impl Into<Number>, ) -> Result<OcString>

Self::read_sector 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: drive.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 write_byte( &self, offset: impl Into<Number>, value: impl Into<Number>, ) -> Result<()>

Write a single byte to the specified offset.

Lua: drive.writeByte(offset:number, value:number) Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn write_byte_async( &self, offset: impl Into<Number>, value: impl Into<Number>, ) -> Result<()>

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

Source

pub fn write_sector( &self, sector: impl Into<Number>, value: impl AsRef<[u8]>, ) -> Result<()>

Write the specified contents to the specified sector.

Lua: drive.writeSector(sector:number, value:string) Direct call (runs immediately, drawing on the per-tick budget).

Source

pub async fn write_sector_async( &self, sector: impl Into<Number>, value: impl AsRef<[u8]>, ) -> Result<()>

Self::write_sector 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 Drive

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 Drive

Source§

const KIND: &'static str = "drive"

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 Drive

Source§

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

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

impl Eq for Drive

Source§

impl Hash for Drive

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 Drive

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 Drive

Auto Trait Implementations§

§

impl Forget for Drive

§

impl Freeze for Drive

§

impl Move for Drive

§

impl RefUnwindSafe for Drive

§

impl Send for Drive

§

impl Sync for Drive

§

impl Unpin for Drive

§

impl UnsafeUnpin for Drive

§

impl UnwindSafe for Drive

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.