Struct oracle::sql_type::Collection

pub struct Collection { /* fields omitted */ }

Oracle-specific collection data type

This type corresponds to varray and nested table data types. See Oracle manual.

let conn = Connection::connect("scott", "tiger", "")?;

// MDSYS.SDO_ELEM_INFO_ARRAY is defined as VARRAY (1048576) of NUMBER.
let objtype = conn.object_type("MDSYS.SDO_ELEM_INFO_ARRAY")?;

// Create a new collection
let mut obj = objtype.new_collection()?;
obj.push(&1);
obj.push(&3);
assert_eq!(obj.to_string(), "MDSYS.SDO_ELEM_INFO_ARRAY(1, 3)");

Note: Methods in the type may be changed in future.

Methods

impl Collection

pub fn object_type(&self) -> &ObjectType

Returns type information.

pub fn size(&self) -> Result<i32>

Returns the number of elements.

This counts also deleted elements. See "Comments" about OCICollSize().

pub fn first_index(&self) -> Result<i32>

Returns the first index.

Use this method if indexes of the collection isn't continuous.

pub fn last_index(&self) -> Result<i32>

Returns the last index.

Use this method if indexes of the collection isn't continuous.

pub fn next_index(&self, index: i32) -> Result<i32>

Returns the next index following the specified index.

Use this method if indexes of the collection isn't continuous.

pub fn prev_index(&self, index: i32) -> Result<i32>

Returns the previous index following the specified index.

Use this method if indexes of the collection isn't continuous.

pub fn exist(&self, index: i32) -> Result<bool>

Returns whether an element exists at the specified index.

pub fn get<T>(&self, index: i32) -> Result<T> where
    T: FromSql, 

Returns the value of the element at the specified index.

pub fn set(&mut self, index: i32, value: &dyn ToSql) -> Result<()>

Sets the value to the element at the specified index.

pub fn push(&mut self, value: &dyn ToSql) -> Result<()>

Appends an element to the end of the collection.

pub fn remove(&mut self, index: i32) -> Result<()>

Remove the element at the specified index. Note that the position ordinals of the remaining elements are not changed. The operation creates holes in the collection.

pub fn trim(&mut self, len: usize) -> Result<()>

Trims a number of elements from the end of a collection.

If the number of of elements to trim exceeds the current size of the collection an error is returned.

Trait Implementations

impl FromSql for Collection

fn from_sql(val: &SqlValue) -> Result<Collection>

impl ToSql for Collection

fn oratype(&self, _conn: &Connection) -> Result<OracleType>

fn to_sql(&self, val: &mut SqlValue) -> Result<()>

impl Drop for Collection

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl Display for Collection

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

Formats the value using the given formatter.