Skip to main content

Database

Struct Database 

Source
pub struct Database(pub Address);
Expand description

The database component (7 methods).

Provided by OpenComputers’ UpgradeDatabase.

Tuple Fields§

§0: Address

Implementations§

Source§

impl Database

Source

pub fn clear(&self, slot: impl Into<Number>) -> Result<bool>

Clears the specified slot. Returns true if there was something in the slot before.

Lua: database.clear(slot:number):boolean Indirect call: waits for the next server tick.

Source

pub async fn clear_async(&self, slot: impl Into<Number>) -> Result<bool>

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

Source

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

Copies the data stored in this database to another database with the specified address.

Lua: database.clone(address:string):number Indirect call: waits for the next server tick.

Source

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

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

Source

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

Computes a hash value for the item stack in the specified slot.

Lua: database.computeHash(slot:number):string Indirect call: waits for the next server tick.

Source

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

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

Source

pub fn copy( &self, from_slot: impl Into<Number>, to_slot: impl Into<Number>, address: Option<&str>, ) -> Result<bool>

Copies an entry to another slot, optionally to another database. Returns true if something was overwritten.

Lua: database.copy(fromSlot:number, toSlot:number[, address:string]):boolean Indirect call: waits for the next server tick.

Source

pub async fn copy_async( &self, from_slot: impl Into<Number>, to_slot: impl Into<Number>, address: Option<&str>, ) -> Result<bool>

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

Source

pub fn get(&self, slot: impl Into<Number>) -> Result<Value>

Get the representation of the item stack stored in the specified slot.

Lua: database.get(slot:number):table Indirect call: waits for the next server tick.

Source

pub async fn get_async(&self, slot: impl Into<Number>) -> Result<Value>

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

Source

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

Get the index of an item stack with the specified hash. Returns a negative value if no such stack was found.

Lua: database.indexOf(hash:string):number Indirect call: waits for the next server tick.

Source

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

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

Source

pub fn set( &self, slot: impl Into<Number>, id: impl AsRef<[u8]>, damage: impl Into<Number>, nbt: impl AsRef<[u8]>, ) -> Result<bool>

Sets an item into the specified database slot. The NBT tag is expected in string (SNBT) format.

Lua: database.set(slot:number, id:string, damage:number, nbt:string):boolean Indirect call: waits for the next server tick.

Source

pub async fn set_async( &self, slot: impl Into<Number>, id: impl AsRef<[u8]>, damage: impl Into<Number>, nbt: impl AsRef<[u8]>, ) -> Result<bool>

Self::set 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 Database

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 Database

Source§

const KIND: &'static str = "database"

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 Database

Source§

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

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

impl Eq for Database

Source§

impl Hash for Database

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 Database

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 Database

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.