BLob

Struct BLob 

Source
pub struct BLob(/* private fields */);
Expand description

LOB implementation for binary values.

BLob is used within HdbValue::BLOB instances received from the database.

Bigger LOBs are not transferred completely in the first roundtrip, instead more data is fetched in subsequent roundtrips when needed.

BLob respects the Connection’s lob read length (see Connection::set_lob_read_length).

Implementations§

Source§

impl BLob

Source

pub async fn into_bytes(self) -> HdbResult<Vec<u8>>

Converts the BLob into a Vec.

All outstanding data (data that were not yet fetched from the server) are fetched into this BLob object, before the complete data, as far as they were not yet read from this BLob object, are returned.

§Example
 let mut result_set = connection.query(query)?;
 let mut blob = result_set.into_single_row()?.into_single_value()?.try_into_blob()?;

 let b = blob.into_bytes()?; // Vec<u8>, can be huge
§Alternative

For larger objects, a streaming approach using BLob::write_into might by more appropriate, to avoid total allocation of the large object.

§Errors

Several variants of HdbError can occur.

Source

pub async fn write_into<W: Unpin + AsyncWriteExt>( self, writer: &mut W, ) -> HdbResult<()>

Writes the content into the given writer.

Reads outstanding data in chunks of size Connection::lob_read_length from the database and writes them immediately into the writer, thus avoiding that all data are materialized within this BLob.

§Errors

Various errors can occur.

Source

pub async fn read_slice( &mut self, offset: u64, length: u32, ) -> HdbResult<Vec<u8>>

Reads from given offset and the given length, in bytes.

§Errors

Several variants of HdbError can occur.

Source

pub fn total_byte_length(&self) -> u64

Total length of data, in bytes.

Source

pub fn is_empty(&self) -> bool

Returns true if the BLob does not contain data.

Source

pub fn cur_buf_len(&self) -> usize

Current size of the internal buffer, in bytes.

Source

pub fn server_usage(&self) -> ServerUsage

Provides information about the the server-side resource consumption that is related to this BLob object.

Trait Implementations§

Source§

impl Clone for BLob

Source§

fn clone(&self) -> BLob

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

impl Debug for BLob

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for BLob

§

impl !RefUnwindSafe for BLob

§

impl Send for BLob

§

impl Sync for BLob

§

impl Unpin for BLob

§

impl !UnwindSafe for BLob

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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,