Skip to main content

Crate archipelago_rs

Crate archipelago_rs 

Source

Modules§

tags
Well-known tags for Archipelago clients with specific semantics attached.

Structs§

BounceOptions
A builder for options for which clients will receive a [Client.bounce]. By default, all teammates receive it.
Cache
The cache in which we store data packages to avoid requesting them every time the client starts.
Client
The client that talks to the Archipelago server using the Archipelago protocol.
Connecting
The state of the Archipelago connection during the initial sequence of protocol handshakes.
Connection
A connection to the Archipelago server. This includes connections that are still being established as well as connections that have been closed.
ConnectionOptions
A builder that defines options for Connection::new.
ConnectionStateTransition
A struct representing a transition from one state to another. This guarantees that old and new are always different, and that old will always be an earlier state than new.
CreateHintsOptions
A builder for options for Client::create_hints_with_options.
DeathLinkOptions
A builder for options that can be passed to [Client.death_link].
Game
Information about a single game in an Archipelago multiworld.
Item
An Archipelago item for some player’s game.
LocatedItem
An item associated with a particular location in particular player’s world.
Location
A location in a game where an item may be placed.
Player
A single player (that is, slot) in the multiworld.
ReceivedItem
An item that was received from the server.
Version
A version of Archipelago, including the server and the generator.

Enums§

ArgumentError
Errors caused by the user invoking the client incorrectly.
ClientStatus
Possible states for the client.
ConnectionError
Possible individual errors that can cause an initial Archipelago connection to fail.
ConnectionState
The current state of a Connection.
ConnectionStateType
An enumeration of possible types of ConnectionStates, without any extra data attached. Unlike the full ConnectionState, this implements Copy and can be cheaply stored and used to represent state transitions.
CreateAsHint
Options for whether and how locations scouted with [Client.scout_locations] should be broadcast as player-visible hints.
DataStorageOperation
Operations that can be applied to keys in the Archipelago server’s data store.
Error
The enumeration of all possible errors that can occur in an Archipelago connection.
Event
Events from the Archipelago server that clients may want to handle.
HintStatus
ItemHandling
Possible options for handling items.
Permission
Permissions for when certain actions (such as releasing all checks) may be performed.
Print
A rich-text message sent by the server, with annotations indicating how the text should be formatted and what individual components refer to.
ProtocolError
Errors caused by the Archipelago doing something that violates (our understanding of) the network protocol.
RichText
A single text component of a Print, with additional metadata indicating its formatting and semantics.
TextColor
Possible colors for Archipelago text.
UpdatedField
An enum that indicates exactly what in a Client was updated.

Traits§

AsItemId
A trait for values that can be interpreted as Archipelago items.
AsLocationId
A trait for values that can be interpreted as Archipelago locations.
Iter
The trait of most iterators returned by this package. This allows us to keep iterator implementations opaque while still guaranteeing that they implement various useful traits.
UnsizedIter
The trait of iterators returned by this package that don’t have a size known ahead of time. This allows us to keep iterator implementations opaque while still guaranteeing that they implement various useful traits.