Struct ArchiveStream 

pub struct ArchiveStream {
    pub id: ArchiveId,
}

Serialized arguments for the archive_stream server function.

Fields

id: ArchiveId

Methods from Deref<Target = ArchiveId>

pub fn is_simple(&self) -> bool

Returns true if this is a top-level id (contains no forward slashes).

Examples

let top = ArchiveId::from_str("math").unwrap();
assert!(top.is_simple());

let nested = ArchiveId::from_str("math/algebra").unwrap();
assert!(!nested.is_simple());

pub fn up(&self) -> Option<ArchiveId>

Returns the parent of this Id, if this Id is not simple

pub fn last(&self) -> &str

Returns the last segment of the hierarchical [ArchiveId].

Examples

let archive_id = ArchiveId::from_str("org/project/archive").unwrap();
assert_eq!(archive_id.last(), "archive");

let simple = ArchiveId::from_str("simple").unwrap();
assert_eq!(simple.last(), "simple");

pub fn first(&self) -> &str

Returns the first segment of the hierarchical [ArchiveId].

Examples

let archive_id = ArchiveId::from_str("org/project/archive").unwrap();
assert_eq!(archive_id.first(), "org");

let simple = ArchiveId::from_str("simple").unwrap();
assert_eq!(simple.first(), "simple");

pub fn steps(&self) -> impl DoubleEndedIterator

Returns an iterator over all segments in the hierarchical [ArchiveId].

The iterator supports both forward and backward iteration.

Examples

let archive_id = ArchiveId::from_str("org/project/archive").unwrap();
let segments: Vec<&str> = archive_id.steps().collect();
assert_eq!(segments, vec!["org", "project", "archive"]);

let reversed: Vec<&str> = archive_id.steps().rev().collect();
assert_eq!(reversed, vec!["archive", "project", "org"]);

pub fn is_meta(&self) -> bool

Returns true if this [ArchiveId] represents a META-INF archive.

META-INF archives are special archives that contain metadata for all archives in the same identifier space.

Examples

assert!(ArchiveId::from_str("some/path/meta-inf").unwrap().is_meta());
assert!(ArchiveId::from_str("some/path/META-INF").unwrap().is_meta());
assert!(ArchiveId::from_str("some/path/Meta-Inf").unwrap().is_meta());
assert!(!ArchiveId::from_str("some/path/metadata").unwrap().is_meta());
assert!(!ArchiveId::from_str("meta-inf/subpath").unwrap().is_meta());

Trait Implementations

impl Clone for ArchiveStream

fn clone(&self) -> ArchiveStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiveStream

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

Formats the value using the given formatter.

impl Deref for ArchiveStream

type Target = ArchiveId

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ArchiveStream

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ArchiveId> for ArchiveStream

fn from(id: ArchiveId) -> Self

Converts to this type from the input type.

impl From<ArchiveStream> for ArchiveId

fn from(value: ArchiveStream) -> Self

Converts to this type from the input type.

impl Serialize for ArchiveStream

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ServerFn for ArchiveStream

const PATH: &'static str

A unique path for the server function’s API endpoint, relative to the host, including its prefix.

type Client = BrowserClient

The type of the HTTP client that will send the request from the client side.

type Server = AxumServerFnBackend

The type of the HTTP server that will send the response from the server side.

type Protocol = Http<GetUrl, Streaming>

The protocol the server function uses to communicate with the client.

type Output = ByteStream<ServerFnError<String>>

The return type of the server function.

type Error = ServerFnError<String>

The type of error in the server function return. Typically [ServerFnError], but allowed to be any type that implements [FromServerFnError].

type InputStreamError = ServerFnError<String>

The type of error in the server function for stream items sent from the client to the server. Typically [ServerFnError], but allowed to be any type that implements [FromServerFnError].

type OutputStreamError = ServerFnError<String>

The type of error in the server function for stream items sent from the server to the client. Typically [ServerFnError], but allowed to be any type that implements [FromServerFnError].

fn middlewares() -> Vec<Arc<dyn Layer<<Self::Server as Server<Self::Error>>::Request, <Self::Server as Server<Self::Error>>::Response>>>

Middleware that should be applied to this server function.

fn run_body( self, ) -> impl Future<Output = Result<ByteStream<ServerFnError<String>>, ServerFnError<String>>> + Send

The body of the server function. This will only run on the server.

fn url() -> &'static str

Returns [Self::PATH].