Struct SpiceDbConfig 

pub struct SpiceDbConfig {
    pub endpoint: String,
    pub token: Option<String>,
}

Configuration for connecting to a SpiceDB instance.

SpiceDbConfig contains the necessary connection parameters for establishing a gRPC connection to SpiceDB. It supports configuration via environment variables or command-line arguments using clap.

Configuration Methods

You can configure SpiceDB connection in three ways:

1. Directly in code - Create the struct manually
2. Environment variables - Set SPICEDB_ENDPOINT and SPICEDB_TOKEN
3. Command-line arguments - Use --spicedb-endpoint and --spicedb-token

Examples

Manual configuration

use authz::SpiceDbConfig;

let config = SpiceDbConfig {
    endpoint: "localhost:50051".to_string(),
    token: Some("your-preshared-key".to_string()),
};

From environment variables

export SPICEDB_ENDPOINT="grpc.authzed.com:443"
export SPICEDB_TOKEN="your-preshared-key"

use authz::SpiceDbConfig;
use clap::Parser;

let config = SpiceDbConfig::parse();

From command-line arguments

cargo run -- --spicedb-endpoint localhost:50051 --spicedb-token mykey

Security Note

The token field contains a sensitive preshared key. Ensure it is:

• Never hardcoded in version control
• Stored securely (e.g., environment variables, secrets manager)
• Transmitted only over secure connections (TLS/SSL)

Fields

endpoint: String

The SpiceDB endpoint URL.

This should be the gRPC endpoint of your SpiceDB server, including the port. The scheme (http:// or https://) is optional and will be added automatically if not present.

Examples

• "localhost:50051" - Local development
• "grpc.authzed.com:443" - AuthZed managed service
• "spicedb.example.com:443" - Custom deployment

Environment Variable

Can be set via SPICEDB_ENDPOINT environment variable.

Default

Defaults to "localhost:50051" if not specified.

token: Option<String>

The preshared key for authenticating with SpiceDB.

This is a secret token used to authenticate your application with the SpiceDB server. If None, the connection will be made without authentication (useful for local development with SpiceDB running in insecure mode).

Security

This token grants access to your authorization data. Keep it secure:

• Never commit it to version control
• Use environment variables or a secrets manager
• Rotate it regularly
• Use different tokens for different environments

Environment Variable

Can be set via SPICEDB_TOKEN environment variable.

Examples

use authz::SpiceDbConfig;

// With authentication
let secure_config = SpiceDbConfig {
    endpoint: "grpc.authzed.com:443".to_string(),
    token: Some("tc_my_secret_token_abc123".to_string()),
};

// Without authentication (local dev only)
let local_config = SpiceDbConfig {
    endpoint: "localhost:50051".to_string(),
    token: None,
};

Trait Implementations

impl Args for SpiceDbConfig

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for SpiceDbConfig

fn clone(&self) -> SpiceDbConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for SpiceDbConfig

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for SpiceDbConfig

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

Formats the value using the given formatter.

impl FromArgMatches for SpiceDbConfig

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for SpiceDbConfig

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.