Response

Struct Response 

Source
pub struct Response<T, HasInfo>
where T: DatabaseStream,
{ query: Query<T, HasInfo>, info_prefix: Option<Vec<u8>>, info_complete: bool, is_ok: bool, result_complete: bool, }
Expand description

Response from a command. Depending on the command, it may or may not return UTF-8 string. Result is read using the Read trait.

§Example

use basex::{Client, ClientError, Connection};
use std::io::Read;

let mut client = Client::connect("localhost", 1984, "admin", "admin")?;

let info = client.create("shovels")?.without_input()?;
assert!(info.starts_with("Database 'shovels' created"));
client.store("blob", &mut &[0u8, 1, 2, 3, 4][..])?;

let mut result: Vec<u8> = vec![];
let mut response = client.execute("RETRIEVE blob")?;
response.read_to_end(&mut result)?;

let (mut client, info) = response.close()?;
assert!(info.starts_with("Query executed in"));

let (mut client, _) = client.execute("OPEN shovels")?.close()?;
client.execute("CLOSE")?.close()?;

Fields§

§query: Query<T, HasInfo>§info_prefix: Option<Vec<u8>>§info_complete: bool§is_ok: bool§result_complete: bool

Implementations§

Source§

impl<T, HasInfo> Response<T, HasInfo>
where T: DatabaseStream,

Source

pub(crate) fn new(query: Query<T, HasInfo>) -> Self

Source

pub fn close(self) -> Result<Query<T, HasInfo>>

Reads info and returns back client.

§Panics

Panics when the stream ends before result is fully streamed.

§Example
use basex::{Client, ClientError, Connection};
use std::io::Read;

let client = Client::connect("localhost", 1984, "admin", "admin")?;
let mut response = client.execute("CLOSE")?;
let (client, info) = response.close()?;
println!("{}", info);
Source

fn connection(&mut self) -> &mut Connection<T, Authenticated>

Trait Implementations§

Source§

impl<T, HasInfo> Read for Response<T, HasInfo>
where T: DatabaseStream,

Source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · Source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
Source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · Source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · Source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf. Read more
Source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
Source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations§

§

impl<T, HasInfo> Freeze for Response<T, HasInfo>
where T: Freeze,

§

impl<T, HasInfo> RefUnwindSafe for Response<T, HasInfo>
where HasInfo: RefUnwindSafe, T: RefUnwindSafe,

§

impl<T, HasInfo> Send for Response<T, HasInfo>
where HasInfo: Send, T: Send,

§

impl<T, HasInfo> Sync for Response<T, HasInfo>
where HasInfo: Sync, T: Sync,

§

impl<T, HasInfo> Unpin for Response<T, HasInfo>
where HasInfo: Unpin, T: Unpin,

§

impl<T, HasInfo> UnwindSafe for Response<T, HasInfo>
where HasInfo: UnwindSafe, T: UnwindSafe,

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> 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, 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.