Enum BraidError 

#[non_exhaustive]
pub enum BraidError {
    Http(String),
    Io(Error),
    HeaderParse(String),
    BodyParse(String),
    InvalidVersion(String),
    Subscription(String),
    Json(Error),
    SubscriptionClosed,
    InvalidSubscriptionStatus(u16),
    Protocol(String),
    Timeout,
    Aborted,
    Fs(String),
    InvalidUtf8(FromUtf8Error),
    Config(String),
    Internal(String),
    HistoryDropped,
    MergeConflict(String),
    Notify(Error),
    Anyhow(String),
}

Errors that can occur during Braid HTTP operations.

Each variant represents a different failure mode when working with Braid protocol. Use pattern matching to handle specific errors appropriately.

Examples

use crate::core::BraidError;

fn handle_error(err: BraidError) {
    match err {
        BraidError::HistoryDropped => {
            println!("Server dropped history, restarting sync");
        },
        BraidError::Timeout => {
            println!("Retrying operation...");
        },
        _ => eprintln!("Error: {}", err),
    }
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Http(String)

HTTP request failed with a given error message.

This includes cases where the server returns an unexpected status code or the request cannot be completed.

Io(Error)

Network I/O error (connection failed, read/write error, etc.).

These errors are typically retryable.

HeaderParse(String)

Failed to parse Braid protocol headers.

Indicates the server sent malformed Version, Parents, Merge-Type, or other Braid-specific headers (Section 2 and 3).

BodyParse(String)

Failed to parse protocol body.

The response body is malformed or doesn’t match the declared format.

InvalidVersion(String)

Invalid version format (not a valid version identifier).

Version IDs must be valid JSON strings or integers (RFC 8941).

Subscription(String)

Subscription-specific error.

Includes issues with subscription setup, maintenance, or unexpected closure.

Json(Error)

JSON serialization or deserialization error.

Indicates a problem encoding or decoding JSON in request/response bodies.

SubscriptionClosed

Subscription closed unexpectedly.

The server closed the connection while a subscription was active. This is a retryable error - the client should resume the subscription.

InvalidSubscriptionStatus(u16)

Invalid subscription status (expected 209)

Protocol(String)

Protocol violation error

Timeout

Operation timed out.

Aborted

Request was aborted.

Fs(String)

Filesystem error (notify, mapping, etc.)

InvalidUtf8(FromUtf8Error)

Invalid UTF-8 sequence in response.

Response body or headers contain invalid UTF-8 encoding.

Config(String)

Configuration error in Braid setup.

Invalid parameters were provided when creating a client or server.

Internal(String)

Internal error in the library.

Indicates a bug or unexpected state in the implementation.

HistoryDropped

Server has dropped version history (HTTP 410 Gone - Section 4.5).

Not retryable. The server has discarded history before the requested version. The client must restart synchronization from scratch by clearing its local state. This error signals that the parents requested are no longer available on the server.

MergeConflict(String)

Conflicting versions detected in merge (HTTP 293 - Section 2.2).

Notify(Error)

Notify/Watcher error.

Anyhow(String)

Generic anyhow error (temporary for conversion).

Implementations

impl BraidError

pub fn is_retryable(&self) -> bool

Check if this error is retryable.

Returns true for transient errors that may succeed on retry:

• Network timeouts
• I/O errors
• HTTP 408, 425, 429, 502, 503, 504

Returns false for permanent errors:

• Protocol violations
• History dropped
• Access denied

Examples

use crate::core::BraidError;

assert!(BraidError::Timeout.is_retryable());
assert!(!BraidError::HistoryDropped.is_retryable());

pub fn is_access_denied(&self) -> bool

Check if this is an access denied error.

Returns true for HTTP 401 (Unauthorized) or 403 (Forbidden).

Examples

use crate::core::BraidError;

let err = BraidError::Http("401 Unauthorized".into());
assert!(err.is_access_denied());

Trait Implementations

impl Debug for BraidError

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

Formats the value using the given formatter.

impl Display for BraidError

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

Formats the value using the given formatter.

impl Error for BraidError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for BraidError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BraidError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BraidError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for BraidError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for BraidError

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.