gRPC schema

Fetch the protobuf schema of the Synthient gRPC API.

With the grpcschema feature, the synthient::grpcschema module fetches the protobuf schema of the Synthient gRPC API using gRPC server reflection.

cargo add synthient --features grpcschema

• Connection: Unless plaintext is set, the connection uses rustls with the platform's trusted certificates, whichever TLS feature the HTTP client uses.
• Re-exports: The module re-exports prost, prost_types, and tonic's Code.

fetch

Starts a fetch of the protobuf files that define the server's services, along with all of their imports.

pub fn fetch(api_key: impl Into<String>) -> Fetch

use synthient::grpcschema;

let schema = match grpcschema::fetch(std::env::var("SYNTHIENT_API_KEY")?).await {
    Ok(schema) => schema,
    Err(err) => match err.explain() {
        Some(explanation) => return Err(format!("{explanation} {err}").into()),
        None => return Err(err.into()),
    },
};

println!("endpoint: {}", schema.endpoint);
for symbol in &schema.symbols {
    println!("service: {symbol}");
}
for file in &schema.descriptor_set.file {
    println!("file: {} (package {})", file.name(), file.package());
}

• Auth: api_key is sent as x-api-key metadata unless it is blank.
• Network: Nothing is sent until the returned Fetch is awaited, so change its options first.
• Traits: Fetch implements IntoFuture with Output = Result<Schema, SchemaError>, and the future is Send + 'static.

Fetch

The default fetches every service from DEFAULT_ENDPOINT over TLS within 30 seconds.

pub fn endpoint(self, endpoint: impl Into<String>) -> Self
pub fn plaintext(self, plaintext: bool) -> Self
pub fn symbols<I, S>(self, symbols: I) -> Self
where
    I: IntoIterator<Item = S>,
    S: Into<String>,
pub fn timeout(self, timeout: Duration) -> Self

Schema

The protobuf schema returned by fetch.

FileDescriptorSet is prost_types::FileDescriptorSet. Encode it with prost::Message::encode_to_vec for tools such as grpcurl and buf:

use synthient::grpcschema::{self, prost::Message};

let schema = grpcschema::fetch(std::env::var("SYNTHIENT_API_KEY")?).await?;
std::fs::write("synthient.binpb", schema.descriptor_set.encode_to_vec())?;

SchemaError

A failed schema fetch. Its Display output describes the failure, and source() returns the underlying error when there is one.

explain

Returns a human-readable explanation of a common failure, or None.

pub fn explain(&self) -> Option<&'static str>

Constants