Indradb Proto

https://docs.rs/indradb-proto/latest/
Admin
Indradb Proto provides protocol definitions and generated client/server implementations for...
Tokens:276,639
Snippets:1,815
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Tonic Server Setup for SyncSvc

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

This code demonstrates how to set up the `SyncSvc` within a Tonic server context. It includes handling compression encodings and preparing the service for request processing using ProstCodec.

```rust
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
    let inner = inner.0;
    let method = SyncSvc(inner);
    let codec = tonic::codec::ProstCodec::default();
};
```

--------------------------------

### gRPC Server Initialization

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Initializes a gRPC server with compression configurations. This snippet shows the setup of the server using tonic's Grpc type, applying compression settings for accepted and sent encodings.

```rust
let mut grpc = tonic::server::Grpc::new(codec)
    .apply_compression_config(
        accept_compression_encodings,
        send_compression_encodings,
    );
let res = grpc.unary(method, req).await;
Ok(res)
```

--------------------------------

### Rust Ecosystem Links

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_server/index

Provides helpful links to resources within the Rust ecosystem, such as the Rust website, The Book, Standard Library API Reference, and Cargo Guide.

```Rust
Rust Ecosystem:
  - Rust website: https://www.rust-lang.org/
  - The Book: https://doc.rust-lang.org/book/
  - Standard Library API Reference: https://doc.rust-lang.org/std/
  - Rust by Example: https://doc.rust-lang.org/rust-by-example/
  - The Cargo Guide: https://doc.rust-lang.org/cargo/guide/
  - Clippy Documentation: https://doc.rust-lang.org/nightly/clippy
```

--------------------------------

### IndraDbClient Methods

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_client/struct.IndraDbClient

Provides a comprehensive list of methods for interacting with the IndraDB database. These methods cover data manipulation (create, delete, get), bulk operations, connection management, plugin execution, and client configuration.

```APIDOC
IndraDbClient:
  accept_compressed(compressed: bool)
    Enables or disables compressed data transfer.

  bulk_insert(edges: Vec<Edge>, vertices: Vec<Vertex>)
    Inserts multiple edges and vertices in a single operation.

  connect(url: &str)
    Establishes a connection to the IndraDB server.

  create_edge(edge: Edge)
    Creates a new edge in the database.

  create_vertex(vertex: Vertex)
    Creates a new vertex in the database.

  create_vertex_from_type(vertex_type: &str, properties: HashMap<String, Value>)
    Creates a new vertex with a specified type and properties.

  delete(ids: Vec<u64>)
    Deletes vertices and their associated edges by their IDs.

  execute_plugin(plugin_name: &str, args: Vec<Value>)
    Executes a specified plugin with given arguments.

  get(ids: Vec<u64>)
    Retrieves vertices and their associated edges by their IDs.

  index_property(vertex_type: &str, property_name: &str)
    Creates an index on a specific property of a vertex type.

  new()
    Creates a new instance of IndraDbClient.

  ping()
    Checks the connection status to the IndraDB server.

  send_compressed(compressed: bool)
    Configures the client to send data in compressed format.

  set_properties(id: u64, properties: HashMap<String, Value>)
    Sets or updates properties for a given vertex.

  sync()
    Synchronizes the client with the database state.

  with_interceptor(interceptor: impl Interceptor)
    Applies an interceptor to the client for custom request handling.

  with_origin(origin: &str)
    Sets the origin for client requests.
```

--------------------------------

### gRPC Server Initialization and Compression

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Demonstrates the initialization of a gRPC server with compression configurations. It shows how to apply accept and send compression encodings to the server.

```rust
let mut grpc = tonic::server::Grpc::new(codec)
    .apply_compression_config(
        accept_compression_encodings,
        send_compression_encodings,
    );
let res = grpc.unary(method, req).await;
Ok(res)
```

--------------------------------

### IndraDB Get Method

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Implements the server-streaming Get method for the IndraDB gRPC service. It handles service readiness and maps potential errors to tonic::Status.

```rust
self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static("/indradb.IndraDB/Get");
            self.inner.server_streaming(request.into_request(), path, codec).await
```

--------------------------------

### Implement Get gRPC Server Streaming Service

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

This snippet shows the implementation of a server streaming service for the Get method in IndraDB. It defines the service structure, response types, and implements the necessary traits for gRPC server streaming.

```rust
struct GetSvc<T: IndraDb>(pub Arc<T>);

impl<T: IndraDb> tonic::server::ServerStreamingService<super::Query>
for GetSvc<T> {
    type Response = super::QueryOutputValue;
    type ResponseStream = T::GetStream;
    type Future = BoxFuture<
```

--------------------------------

### PipeQuery Methods

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.PipeQuery

Provides methods for interacting with PipeQuery, specifically for setting and getting the direction of a query.

```rust
pub fn direction(&self) -> Direction;
pub fn set_direction(&mut self, direction: Direction);
```

--------------------------------

### IndraDbServer Initialization

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Provides methods for creating a new IndraDbServer instance. `new` takes an owned IndraDb implementation, while `from_arc` takes an Arc-wrapped implementation.

```rust
impl<T: IndraDb> IndraDbServer<T> {
    pub fn new(inner: T) -> Self {
        Self::from_arc(Arc::new(inner))
    }

    pub fn from_arc(inner: Arc<T>) -> Self {
        let inner = _Inner(inner);
        Self {
            inner,
            accept_compression_encodings: Default::default(),
            send_compression_encodings: Default::default(),
        }
    }
}
```

--------------------------------

### RangeVertexQuery Structure

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Specifies the parameters for retrieving a range of vertices, including limits, type filtering, and starting ID.

```APIDOC
RangeVertexQuery:
  limit: u32
    - Limits the number of vertices to get.
  t: Identifier (optional)
    - Filters the type of vertices returned.
  start_id: Uuid (optional)
    - Sets the lowest vertex ID to return.
```

--------------------------------

### IndraDB Proto Modules Overview

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Edge

This section provides an overview of the modules available within the `indradb-proto` crate. It lists key modules such as bulk_insert_item, indra_db_client, indra_db_server, query, and query_output_value, indicating their respective documentation entry points.

```rust
Module: bulk_insert_item
Module: indra_db_client
Module: indra_db_server
Module: query
Module: query_output_value
```

--------------------------------

### IndraDB gRPC Server Implementation

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Shows how to set up and run the IndraDB gRPC server using Tonic. It configures compression settings and applies them to the gRPC service.

```rust
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
    let inner = inner.0;
    let method = GetSvc(inner);
    let codec = tonic::codec::ProstCodec::default();
    let mut grpc = tonic::server::Grpc::new(codec)
        .apply_compression_config(
            accept_compression_encodings,
            send_compression_encodings
        );
    // Further server setup...
};
Box::pin(fut)
```

--------------------------------

### Get Data from IndraDB

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/client.rs

Retrieves values from IndraDB based on a given query. It handles paginated results by iterating through them until all data is fetched.

```rust
pub async fn get<Q: Into<indradb::Query>>(&mut self, q: Q) -> Result<Vec<indradb::QueryOutputValue>, ClientError> {
    let q: crate::Query = q.into().into();
    let mut output = Vec::<indradb::QueryOutputValue>::new();
    let mut res = self.0.get(q).await?.into_inner();
    while let Some(res) = res.next().await {
        output.push(res?.try_into()?);
    }
    Ok(output)
}
```

--------------------------------

### Get Data by Query (Rust)

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Client

Retrieves data from the database based on a provided query. The query can be of any type that can be converted into an `indradb::models::queries::Query`.

```rust
pub async fn get<Q: Into<Query>>( &mut self, q: Q, ) -> Result<Vec<QueryOutputValue>, ClientError>
```

--------------------------------

### RangeVertexQuery Struct Definition

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.RangeVertexQuery

Defines the structure for querying a range of vertices in IndraDB. It includes fields for limiting results, filtering by type, and specifying a starting ID.

```rust
pub struct RangeVertexQuery {
    pub limit: u32,
    pub t: Option<Identifier>,
    pub start_id: Option<Uuid>,
}
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_client/index

Provides an overview of the indradb-proto crate, including its version, license (MPL-2.0), links to its repository and documentation, and a list of its dependencies. It also indicates the percentage of the crate that is documented.

```Rust
Crate: indradb-proto
Version: 4.0.0
License: MPL-2.0
Repository: https://github.com/indradb/indradb
Documentation: https://docs.rs/indradb-proto/latest/indradb_proto/
Dependencies:
- glob ^0.3.0
- indradb-lib ^4.0.0
- indradb-plugin-host ^0.3.0
- libloading ^0.7.4
- prost ^0.11.3
- prost-derive ^0.11.2
- prost-types ^0.11.2
- serde_json ^1.0.57
- tokio ^1.24.2
- tokio-stream ^0.1.11
- tonic ^0.8.3
- uuid ^1.2.2
- tonic-build ^0.8.0
Documentation Coverage: 71.64%
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/enum.EdgeDirection

Lists the available modules within the indradb-proto crate, providing entry points to different functionalities like client, server, and query operations.

```rust
Modules:
  * bulk_insert_item
  * indra_db_client
  * indra_db_server
  * query
  * query_output_value
```

--------------------------------

### VertexProperty Blanket Implementations

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.VertexProperty

Details blanket implementations for `VertexProperty`, specifically the `Any` trait. The `Any` trait provides a way to get the `TypeId` of an instance, useful for runtime type identification.

```rust
impl<T> Any for T where T: 'static + ?Sized
#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.
```

--------------------------------

### Rust Edge Message Implementation

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Edge

Implements the prost::message::Message trait for the Edge struct. This includes methods for getting the encoded length of the message and clearing the message.

```rust
fn encoded_len(&self) -> usize
fn clear(&mut self)
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_server/index

Provides an overview of the indradb-proto crate, including its version, license, source code links, and dependencies. It also indicates the percentage of documented code.

```Rust
Crate: indradb-proto
Version: 4.0.0
License: MPL-2.0
Documentation: 71.64% documented
Links:
  - Docs.rs: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_server/index.html
  - GitHub: https://github.com/indradb/indradb
  - Crates.io: https://crates.io/crates/indradb-proto
Dependencies:
  - glob ^0.3.0
  - indradb-lib ^4.0.0
  - indradb-plugin-host ^0.3.0
  - libloading ^0.7.4
  - prost ^0.11.3
  - prost-derive ^0.11.2
  - prost-types ^0.11.2
  - serde_json ^1.0.57
  - tokio ^1.24.2
  - tokio-stream ^0.1.11
  - tonic ^0.8.3
  - uuid ^1.2.2
  - tonic-build ^0.8.0 (build dependency)
```

--------------------------------

### IndraDB Proto Client API Documentation

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Client

This section provides comprehensive documentation for the IndraDB Proto Client's methods. It includes details on setting properties, performing bulk inserts, indexing properties, and executing plugins, along with their parameters, return types, and potential errors.

```APIDOC
Client:
  set_properties<Q: Into<Query>>( &mut self, q: Q, name: Identifier, value: &[Json] ) -> Result<(), ClientError>
    Sets properties for a given query.
    Parameters:
      q: The query to run.
      name: The name of the property to set.
      value: The value of the property.
    Returns: A Result indicating success or a ClientError.

  bulk_insert( &mut self, items: Vec<BulkInsertItem> ) -> Result<(), ClientError>
    Performs a bulk insert of multiple vertices, edges, and/or properties.
    Note: Datastores may have different performance and safeguard tradeoffs. For maximum protection, consider using transaction equivalents.
    Parameters:
      items: A vector of BulkInsertItem to insert.
    Returns: A Result indicating success or a ClientError.

  index_property( &mut self, name: Identifier ) -> Result<(), ClientError>
    Indexes a property.
    Parameters:
      name: The identifier of the property to index.
    Returns: A Result indicating success or a ClientError.

  execute_plugin( &mut self, name: &str, arg: Json ) -> Result<Json, ClientError>
    Executes a plugin with the given name and arguments.
    Parameters:
      name: The name of the plugin to execute.
      arg: The arguments for the plugin as a Json object.
    Returns: A Result containing the plugin's output as Json or a ClientError.
```

--------------------------------

### indradb-proto API Documentation

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.CreateResponse

API documentation for methods within the indradb-proto library, including `clone_to_uninit`, `from`, `from_ref`, and `instrument`.

```APIDOC
CreateResponse:
  clone_to_uninit(&self, dest: *mut u8) -> () // unsafe, nightly-only
    Performs copy-assignment from `self` to `dest`.

  from(t: T) -> T
    Returns the argument unchanged.

  from_ref(input: &T) -> T
    Converts to this type from a reference to the input type.

  instrument(self, span: Span) -> Instrumented<Self>
    Instruments this type with the provided Span, returning an Instrumented wrapper.
```

--------------------------------

### Rust gRPC Client Call Example

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Demonstrates how to make a gRPC unary call to the IndraDB service to create a vertex. This snippet shows the client-side asynchronous execution of the request.

```rust
let res = grpc.unary(method, req).await;
Ok(res)
```

--------------------------------

### Rust gRPC Client Implementation Snippet

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

A Rust code snippet demonstrating the implementation of a gRPC client for the IndraDB service. It shows how to handle service readiness and make unary calls.

```rust
self.inner
    .ready()
    .await
    .map_err(|e| {
        tonic::Status::new(
            tonic::Code::Unknown,
            format!("Service was not ready: {}", e.into()),
        )
    })?;

let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
    "/indradb.IndraDB/CreateEdge",
);

self.inner.unary(request.into_request(), path, codec).await
```

--------------------------------

### PipePropertyQuery Message Serialization

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.PipePropertyQuery

Implements the Message trait from the prost crate for the PipePropertyQuery struct, enabling serialization and deserialization of the struct. This includes methods for getting encoded length, clearing the message, and encoding it to a buffer.

```APIDOC
impl Message for PipePropertyQuery

  fn encoded_len(&self) -> usize
    Returns the encoded length of the message without a length delimiter.
    Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs.html#211

  fn clear(&mut self)
    Clears the message, resetting all fields to their default.
    Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs.html#211

  fn encode<B: BufMut>(&self, buf: &mut B) -> Result<(), EncodeError>
    Encodes the message to a buffer. Reads more: https://docs.rs/prost/0.11.9/x86_64-unknown-linux-gnu/prost/message/trait.Message.html#method.encode
    Source: https://docs.rs/prost/0.11.9/x86_64-unknown-linux-gnu/src/prost/message.rs.html#65-67
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto/all

Provides an overview of the indradb-proto crate, including its version, license, dependencies, and documentation status. It links to external resources like docs.rs, crates.io, and the project's GitHub repository.

```Rust
Crate: indradb-proto
Version: 4.0.0
License: MPL-2.0
Documentation: 71.64% documented
Dependencies:
  - glob ^0.3.0
  - indradb-lib ^4.0.0
  - indradb-plugin-host ^0.3.0
  - libloading ^0.7.4
  - prost ^0.11.3
  - prost-derive ^0.11.2
  - prost-types ^0.11.2
  - serde_json ^1.0.57
  - tokio ^1.24.2
  - tokio-stream ^0.1.11
  - tonic ^0.8.3
  - uuid ^1.2.2
  - tonic-build ^0.8.0
Links:
  - Project: https://indradb.github.io
  - Repository: https://github.com/indradb/indradb
  - Crates.io: https://crates.io/crates/indradb-proto
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_server/struct.IndraDbServer

Details about the indradb-proto crate, including its version (4.0.0), license (MPL-2.0), source code links, and dependency information.

```Rust
crate: indradb-proto
version: 4.0.0
license: MPL-2.0
dependencies:
  glob ^0.3.0
  indradb-lib ^4.0.0
  indradb-plugin-host ^0.3.0
  libloading ^0.7.4
  prost ^0.11.3
  prost-derive ^0.11.2
  prost-types ^0.11.2
  serde_json ^1.0.57
  tokio ^1.24.2
  tokio-stream ^0.1.11
  tonic ^0.8.3
  uuid ^1.2.2
  tonic-build ^0.8.0
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/index

Provides an overview of the indradb-proto crate, including its version, license, dependencies, and documentation status. It links to the crate's page on docs.rs, its source code repository, and related projects.

```rust
Crate: indradb-proto
Version: 4.0.0
License: MPL-2.0
Documentation: 71.64% documented
Dependencies:
  - glob ^0.3.0
  - indradb-lib ^4.0.0
  - indradb-plugin-host ^0.3.0
  - libloading ^0.7.4
  - prost ^0.11.3
  - prost-derive ^0.11.2
  - prost-types ^0.11.2
  - serde_json ^1.0.57
  - tokio ^1.24.2
  - tokio-stream ^0.1.11
  - tonic ^0.8.3
  - uuid ^1.2.2
  - tonic-build ^0.8.0
Links:
  - Source: https://github.com/indradb/indradb
  - Crates.io: https://crates.io/crates/indradb-proto
  - Docs.rs: https://docs.rs/indradb-proto/latest/indradb_proto/
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto/index

Provides general information about the indradb-proto crate, including links to its source code, license, and related projects.

```Rust
Project: /context7/rs-indrad
License: MPL-2.0
Repository: https://github.com/indradb/indradb
Crates.io: https://crates.io/crates/indrad-proto
```

--------------------------------

### IncludeQuery Protobuf Message Implementation

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.IncludeQuery

Implements the `Message` trait for the IncludeQuery struct, enabling protobuf encoding and decoding. This includes methods for getting the encoded length, clearing the message, encoding to a buffer, and encoding to a vector.

```APIDOC
IncludeQuery:
  impl Message for IncludeQuery
    fn default() -> Self
      Returns the default value for the type.
    fn encoded_len(&self) -> usize
      Returns the encoded length of the message without a length delimiter.
    fn clear(&mut self)
      Clears the message, resetting all fields to their default.
    fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>
      where B: BufMut, Self: Sized
      Encodes the message to a buffer.
    fn encode_to_vec(&self) -> Vec<u8>
      where Self: Sized
      Encodes the message to a newly allocated buffer.
```

--------------------------------

### IndraDB Proto Client API

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Client

API documentation for the indradb-proto Client, covering initialization, server interaction, and data manipulation operations.

```APIDOC
Client:
  __init__(endpoint: Endpoint) -> Result<Client, ClientError>
    Creates a new client instance.
    endpoint: The server endpoint to connect to.
    Returns: A Result containing the new Client or a ClientError.

  ping(&mut self) -> Result<(), ClientError>
    Pings the server to check connectivity.
    Returns: Ok(()) on success, or a ClientError on failure.

  sync(&mut self) -> Result<(), ClientError>
    Syncs persisted content with the server. The exact behavior may vary based on the datastore implementation.
    Returns: Ok(()) on success, or a ClientError on failure.

  create_vertex(&mut self, vertex: &Vertex) -> Result<bool, ClientError>
    Creates a new vertex in the database.
    vertex: The Vertex object to create.
    Returns: Ok(true) if the vertex was created, Ok(false) if a vertex with the same UUID already exists, or a ClientError on failure.
```

--------------------------------

### IndraDB Service API

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Defines the core methods for interacting with the IndraDB service. These methods allow for querying data, deleting data based on queries, and setting properties for data entities. The `get` method returns a stream of query results, while `delete` and `set_properties` perform mutations.

```APIDOC
service IndraDB {
  /// Gets values specified by a query.
  rpc Get(Query) returns (stream QueryOutputValue);

  /// Deletes values specified by a query.
  rpc Delete(Query) returns (google.protobuf.Empty);

  /// Sets properties.
  rpc SetProperties(SetPropertiesRequest) returns (google.protobuf.Empty);

  /// Bulk inserts many vertices, edges, and/or properties.
  /// Note that datastores have discretion on how to approach safeguard vs performance.
  rpc BulkInsert(BulkInsertRequest) returns (google.protobuf.Empty);
}
```

```rust
type GetStream: futures_core::Stream<
    Item = Result<super::QueryOutputValue, tonic::Status>,
> + Send + 'static;

async fn get(
    &self,
    request: tonic::Request<super::Query>,
) -> Result<tonic::Response<Self::GetStream>, tonic::Status>;

async fn delete(
    &self,
    request: tonic::Request<super::Query>,
) -> Result<tonic::Response<()>, tonic::Status>;

async fn set_properties(
    &self,
    request: tonic::Request<super::SetPropertiesRequest>,
) -> Result<tonic::Response<()>, tonic::Status>;

async fn bulk_insert(
    &self,
    request: tonic::Request<super::BulkInsertRequest>,
) -> Result<tonic::Response<()>, tonic::Status>;

```

--------------------------------

### Rust gRPC Delete Service Implementation

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

This snippet demonstrates the implementation of a gRPC delete service in Rust using the `tonic` framework. It shows how to handle incoming delete requests, process them asynchronously, and return the result. The code includes setup for compression configurations and the use of `ProstCodec` for serialization.

```rust
let inner = self.0.clone();
let fut = async move { (*inner).delete(request).await };
Box::pin(fut)
```

```rust
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
    let inner = inner.0;
    let method = DeleteSvc(inner);
    let codec = tonic::codec::ProstCodec::default();
    let mut grpc = tonic::server::Grpc::new(codec)
        .apply_compression_config(
            accept_compression_encodings,
            send_compression_encodings,
        );
    let res = grpc.unary(method, req).await;
    Ok(res)
};
Box::pin(fut)
```

--------------------------------

### IndraDbClient Initialization and Connection

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Provides methods for creating and configuring an IndraDbClient. This includes establishing a connection to a specified endpoint and optionally adding interceptors for custom request handling.

```rust
pub fn new(inner: T) -> Self {
    let inner = tonic::client::Grpc::new(inner);
    Self { inner }
}
```

```rust
pub fn with_origin(inner: T, origin: Uri) -> Self {
    let inner = tonic::client::Grpc::with_origin(inner, origin);
    Self { inner }
}
```

```rust
pub fn with_interceptor<F>(
    inner: T,
    interceptor: F,
) -> IndraDbClient<InterceptedService<T, F>>
where
    T: GrpcService<tonic::body::BoxBody>,
    T::Error: Into<StdError>,
    T::ResponseBody: Body<Data = Bytes> + Send + 'static,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
    let inner = tonic::client::Grpc::with_interceptor(inner, interceptor);
    Self { inner }
}
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.QueryOutputVertexProperties

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### Rust `Into<U>` Trait Implementation

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.ExecutePluginResponse

Provides a generic conversion from type `T` to type `U` if `U` implements `From<T>`. This is a fundamental conversion trait in Rust.

Dependencies: `core::convert::Into`, `core::convert::From`.
Functionality: Enables `self.into()` calls when the target type `U` can be created from `T`.
Example: `let string_val: String = 10.into();`

```rust
impl<T, U> Into<U> for T
where
    U: From<T>,
```

--------------------------------

### IndraDB Proto Modules Overview

Source: https://docs.rs/indradb-proto/latest/indradb_proto/enum.ClientError

This section provides an overview of the modules available within the indradb-proto crate. It lists key modules such as bulk_insert_item, indra_db_client, indra_db_server, query, and query_output_value, indicating the different areas of functionality covered by the crate.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### Rust `ToOwned` Trait Implementations

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.ExecutePluginResponse

Provides methods for creating owned versions of data from borrowed data, typically through cloning. This includes defining the `Owned` associated type and implementing `to_owned` and `clone_into`.

Dependencies: `alloc::borrow::ToOwned`, `core::clone::Clone`.
Functionality: Allows creating owned copies (`to_owned`) or efficiently cloning into existing buffers (`clone_into`).
Example: `let owned_string = borrowed_string.to_owned();`

```rust
impl<T>
ToOwned for T
where
    T: Clone,
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto

Provides an overview of the indradb-proto crate, including its version, license, dependencies, and documentation status. It links to the crate's page on docs.rs, its source code repository, and related projects.

```rust
Crate: indradb-proto
Version: 4.0.0
License: MPL-2.0
Documentation: 71.64% documented
Dependencies:
  - glob ^0.3.0
  - indradb-lib ^4.0.0
  - indradb-plugin-host ^0.3.0
  - libloading ^0.7.4
  - prost ^0.11.3
  - prost-derive ^0.11.2
  - prost-types ^0.11.2
  - serde_json ^1.0.57
  - tokio ^1.24.2
  - tokio-stream ^0.1.11
  - tonic ^0.8.3
  - uuid ^1.2.2
  - tonic-build ^0.8.0
Links:
  - Source: https://github.com/indradb/indradb
  - Crates.io: https://crates.io/crates/indradb-proto
  - Docs.rs: https://docs.rs/indradb-proto/latest/indradb_proto/
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.PipeWithPropertyValueQuery

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Server Implementation

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/lib.rs

Provides the server-side implementation for hosting an IndraDB service. This feature is enabled by the 'server' flag. It allows running the server with or without plugins.

```rust
#[cfg(feature = "server")]
mod server;
#[cfg(feature = "server")]
pub use server::{run as run_server, run_with_plugins as run_server_with_plugins, Server};
```

--------------------------------

### IndraDB Proto Module Structure

Source: https://docs.rs/indradb-proto/latest/indradb_proto/query/index

Overview of the modules available within the indradb-proto crate. This includes modules for bulk inserts, client and server interactions, queries, and query output values.

```Rust
indradb_proto::bulk_insert_item
indradb_proto::indra_db_client
indradb_proto::indra_db_server
indradb_proto::query
indradb_proto::query_output_value
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.VertexWithPropertyPresenceQuery

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.PipeWithPropertyPresenceQuery

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.VertexWithPropertyValueQuery

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB API Reference

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

Reference for the IndraDB gRPC API, detailing available methods for interacting with the database.

```APIDOC
Service: IndraDB

Methods:

  BulkInsert(stream<BulkInsertRequest>) -> BulkInsertResponse
    Description: Handles bulk insertion of data into IndraDB.
    Type: Client Streaming RPC

  IndexProperty(IndexPropertyRequest) -> ()
    Description: Enables indexing on a specified property. When indexing is enabled on a property, it's possible to query on its presence and values.
    Parameters:
      request: IndexPropertyRequest - Contains details for indexing a property.
    Returns: An empty response on success, or a tonic::Status on failure.
    Example Usage:
      let mut client = IndraDBClient::connect("http://[::1]:50051").await?;
      let request = tonic::Request::new(indradb_proto::IndexPropertyRequest { property: "my_property".to_string() });
      let response = client.index_property(request).await?;
      println!("IndexProperty Response: {:?}", response);

```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.QueryOutputEdgeProperties

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.EdgeWithPropertyPresenceQuery

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDb Service Methods

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

This section outlines the available methods for interacting with the IndraDB service, including how to handle compression encodings and the core logic for processing requests.

```APIDOC
IndraDb:
  create_edge(request: tonic::Request<super::Edge>) -> BoxFuture<tonic::Response<super::CreateResponse>, tonic::Status>
    - Handles the creation of a new edge in the database.
    - Takes a `tonic::Request` containing an `super::Edge` object.
    - Returns a `BoxFuture` that resolves to a `tonic::Response` with `super::CreateResponse` or a `tonic::Status`.

Service Configuration:
  accept_compression_encodings: Configures accepted compression encodings.
  send_compression_encodings: Configures sent compression encodings.
  inner: Reference to the underlying IndraDb implementation.
```

--------------------------------

### indradb-proto Module indra_db_client

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_client/index

Details the `indra_db_client` module within the indradb-proto crate, highlighting its structs and providing links to further documentation.

```Rust
Module: indra_db_client
Description: Protobuf/gRPC interfaces for IndraDB.
Items:
- Structs
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.EdgeWithPropertyValueQuery

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### Connect to IndraDB Server

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/client.rs

Establishes a new connection to the IndraDB server using the provided endpoint. This is the initial step to interact with the database.

```rust
pub async fn new(endpoint: Endpoint) -> Result<Self, ClientError> {
    let client = crate::ProtoClient::connect(endpoint).await?;
    Ok(Client(client))
}
```

--------------------------------

### IndraDB Client Implementation

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/indradb-proto-792991a98cb6bbd3/out/indradb.rs

This snippet showcases the core client implementation for interacting with the IndraDB database. It likely handles connection management, query execution, and response parsing.

```rust
pub struct Client {
    // Internal fields for connection and configuration
}

impl Client {
    pub async fn new(connection_string: &str) -> Result<Self, IndraError> {
        // Implementation to establish a connection
        unimplemented!()
    }

    pub async fn execute_query(&self, query: &str) -> Result<QueryResult, IndraError> {
        // Implementation to send a query and receive results
        unimplemented!()
    }

    // Other client methods...
}
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/indra_db_server/index

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### indradb-proto Crate Information

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Query

Provides an overview of the indradb-proto crate, including its version, license, source code links, and dependencies. This information is crucial for understanding the project's ecosystem and integration.

```APIDOC
Crate: indradb-proto
Version: 4.0.0
License: MPL-2.0
Repository: https://github.com/indradb/indradb
Crates.io: https://crates.io/crates/indradb-proto
Documentation: https://docs.rs/indradb-proto/latest/indradb_proto/

Dependencies:
- glob ^0.3.0
- indradb-lib ^4.0.0
- indradb-plugin-host ^0.3.0
- libloading ^0.7.4
- prost ^0.11.3
- prost-derive ^0.11.2
- prost-types ^0.11.2
- serde_json ^1.0.57
- tokio ^1.24.2
- tokio-stream ^0.1.11
- tonic ^0.8.3
- uuid ^1.2.2
- tonic-build ^0.8.0

Platform Support:
- i686-pc-windows-msvc
- i686-unknown-linux-gnu
- x86_64-apple-darwin
- x86_64-pc-windows-msvc
- x86_64-unknown-linux-gnu

Feature Flags: Available via docs.rs
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.QueryOutputValue

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Crate Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.IncludeQuery

This section outlines the modules available within the `indradb-proto` Rust crate. It provides links to the documentation for each module, which are organized by functionality such as `bulk_insert_item`, `indra_db_client`, `indra_db_server`, `query`, and `query_output_value`.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Dependencies

Source: https://docs.rs/indradb-proto/latest/src/indradb_proto/converters.rs

Lists the dependencies for the indradb-proto crate, including version information and whether they are optional or for build purposes. This helps understand the crate's external requirements.

```Rust
glob ^0.3.0
indradb-lib ^4.0.0
indradb-plugin-host ^0.3.0
libloading ^0.7.4
prost ^0.11.3
prost-derive ^0.11.2
prost-types ^0.11.2
serde_json ^1.0.57
tokio ^1.24.2
tokio-stream ^0.1.11
tonic ^0.8.3
uuid ^1.2.2
tonic-build ^0.8.0
```

--------------------------------

### IndraDB Proto Modules Overview

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.Uuid

This provides a high-level overview of the modules available within the indradb-proto crate. It lists key modules such as bulk_insert_item, indra_db_client, indra_db_server, query, and query_output_value, indicating the organizational structure of the library.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.VertexPropertyBulkInsertItem

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```

--------------------------------

### IndraDB Proto Crate Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.QueryOutputEdges

This section outlines the main modules within the indradb-proto Rust crate. It provides links to the documentation for each module, which are organized by functionality such as bulk inserts, client and server interactions, query processing, and query output values.

```rust
pub mod bulk_insert_item;
pub mod indra_db_client;
pub mod indra_db_server;
pub mod query;
pub mod query_output_value;
```

--------------------------------

### IndraDB Proto Modules

Source: https://docs.rs/indradb-proto/latest/indradb_proto/struct.IndexPropertyRequest

Lists the available modules within the indradb-proto crate, providing links to their respective documentation. These modules represent different functional areas of the proto implementation.

```rust
mod bulk_insert_item;
mod indra_db_client;
mod indra_db_server;
mod query;
mod query_output_value;
```
Tokens:
Raw