iroh_docs::api::protocol

Enum DocsProtocol

pub enum DocsProtocol {
Show 26 variants
    Open(OpenRequest),
    Close(CloseRequest),
    Status(StatusRequest),
    List(ListRequest),
    Create(CreateRequest),
    Drop(DropRequest),
    Import(ImportRequest),
    Set(SetRequest),
    SetHash(SetHashRequest),
    Get(GetManyRequest),
    GetExact(GetExactRequest),
    Del(DelRequest),
    StartSync(StartSyncRequest),
    Leave(LeaveRequest),
    Share(ShareRequest),
    Subscribe(SubscribeRequest),
    GetDownloadPolicy(GetDownloadPolicyRequest),
    SetDownloadPolicy(SetDownloadPolicyRequest),
    GetSyncPeers(GetSyncPeersRequest),
    AuthorList(AuthorListRequest),
    AuthorCreate(AuthorCreateRequest),
    AuthorGetDefault(AuthorGetDefaultRequest),
    AuthorSetDefault(AuthorSetDefaultRequest),
    AuthorImport(AuthorImportRequest),
    AuthorExport(AuthorExportRequest),
    AuthorDelete(AuthorDeleteRequest),
}

Variants§

Open(OpenRequest)

Close(CloseRequest)

Status(StatusRequest)

List(ListRequest)

Create(CreateRequest)

Drop(DropRequest)

Import(ImportRequest)

Set(SetRequest)

SetHash(SetHashRequest)

Get(GetManyRequest)

GetExact(GetExactRequest)

Del(DelRequest)

StartSync(StartSyncRequest)

Leave(LeaveRequest)

GetDownloadPolicy(GetDownloadPolicyRequest)

SetDownloadPolicy(SetDownloadPolicyRequest)

GetSyncPeers(GetSyncPeersRequest)

AuthorList(AuthorListRequest)

AuthorCreate(AuthorCreateRequest)

AuthorGetDefault(AuthorGetDefaultRequest)

AuthorSetDefault(AuthorSetDefaultRequest)

AuthorImport(AuthorImportRequest)

AuthorExport(AuthorExportRequest)

AuthorDelete(AuthorDeleteRequest)

Trait Implementations§

impl Debug for DocsProtocol

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for DocsProtocol

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<AuthorCreateRequest> for DocsProtocol

fn from(value: AuthorCreateRequest) -> Self

Converts to this type from the input type.

impl From<AuthorDeleteRequest> for DocsProtocol

fn from(value: AuthorDeleteRequest) -> Self

Converts to this type from the input type.

impl From<AuthorExportRequest> for DocsProtocol

fn from(value: AuthorExportRequest) -> Self

Converts to this type from the input type.

impl From<AuthorGetDefaultRequest> for DocsProtocol

fn from(value: AuthorGetDefaultRequest) -> Self

Converts to this type from the input type.

impl From<AuthorImportRequest> for DocsProtocol

fn from(value: AuthorImportRequest) -> Self

Converts to this type from the input type.

impl From<AuthorListRequest> for DocsProtocol

fn from(value: AuthorListRequest) -> Self

Converts to this type from the input type.

impl From<AuthorSetDefaultRequest> for DocsProtocol

fn from(value: AuthorSetDefaultRequest) -> Self

Converts to this type from the input type.

impl From<CloseRequest> for DocsProtocol

fn from(value: CloseRequest) -> Self

Converts to this type from the input type.

impl From<CreateRequest> for DocsProtocol

fn from(value: CreateRequest) -> Self

Converts to this type from the input type.

impl From<DelRequest> for DocsProtocol

fn from(value: DelRequest) -> Self

Converts to this type from the input type.

impl From<DropRequest> for DocsProtocol

fn from(value: DropRequest) -> Self

Converts to this type from the input type.

impl From<GetDownloadPolicyRequest> for DocsProtocol

fn from(value: GetDownloadPolicyRequest) -> Self

Converts to this type from the input type.

impl From<GetExactRequest> for DocsProtocol

fn from(value: GetExactRequest) -> Self

Converts to this type from the input type.

impl From<GetManyRequest> for DocsProtocol

fn from(value: GetManyRequest) -> Self

Converts to this type from the input type.

impl From<GetSyncPeersRequest> for DocsProtocol

fn from(value: GetSyncPeersRequest) -> Self

Converts to this type from the input type.

impl From<ImportRequest> for DocsProtocol

fn from(value: ImportRequest) -> Self

Converts to this type from the input type.

impl From<LeaveRequest> for DocsProtocol

fn from(value: LeaveRequest) -> Self

Converts to this type from the input type.

impl From<ListRequest> for DocsProtocol

fn from(value: ListRequest) -> Self

Converts to this type from the input type.

impl From<OpenRequest> for DocsProtocol

fn from(value: OpenRequest) -> Self

Converts to this type from the input type.

impl From<SetDownloadPolicyRequest> for DocsProtocol

fn from(value: SetDownloadPolicyRequest) -> Self

Converts to this type from the input type.

impl From<SetHashRequest> for DocsProtocol

fn from(value: SetHashRequest) -> Self

Converts to this type from the input type.

impl From<SetRequest> for DocsProtocol

fn from(value: SetRequest) -> Self

Converts to this type from the input type.

impl From<ShareRequest> for DocsProtocol

fn from(value: ShareRequest) -> Self

Converts to this type from the input type.

impl From<StartSyncRequest> for DocsProtocol

fn from(value: StartSyncRequest) -> Self

Converts to this type from the input type.

impl From<StatusRequest> for DocsProtocol

fn from(value: StatusRequest) -> Self

Converts to this type from the input type.

impl From<SubscribeRequest> for DocsProtocol

fn from(value: SubscribeRequest) -> Self

Converts to this type from the input type.

impl Serialize for DocsProtocol

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl !Freeze for DocsProtocol

impl RefUnwindSafe for DocsProtocol

impl Send for DocsProtocol

impl Sync for DocsProtocol

impl Unpin for DocsProtocol

impl UnwindSafe for DocsProtocol

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> RpcMessage for T
where T: Debug + Serialize + DeserializeOwned + Send + Sync + Unpin + 'static,