Crate rice_c 

rice-c

Bindings for the rice-proto C API.

When to use

The rice-c crate is useful when you have two separate components written in different languages that need to access and modify the same ICE resources. If your application stack is entirely in rust, then using only rice-proto may be sufficient and rice-c may not be needed.

Building

rice-c requires a pre-existing installation of the rice-proto C API that can be found using pkg-config. This detection is performed using system-deps and there are some environment variables that system-deps can use to influence the detection of a rice-proto installation.

You can check if rice-proto is available in your build environment with:

pkg-config --modversion rice-proto

Interface

rice-c provides a very similar interface as rice-proto in order to ease switching between the two implementations (rice-c and rice-proto) as may be required.

Modules

agent

ICE Agent implementation as specified in RFC 8445

candidate

ICE Candidates

component

A Component in an ICE Stream

ffi

FFI module for the raw rice-proto C API.

prelude

Prelude module.

stream

A Stream in an ICE Agent.

turn

TURN module.

Structs

Address

A network address.

Instant

An absolute point in time.

Enums

AddressFamily

The family of an address.

Functions

random_string

Generate a random sequence of characters suitable for username fragments and passwords.