[][src]Crate replit_protocol

The unofficial repl.it container protocol for Rust.

The container protocol is what repl.it uses for communication with it's repl containers. This uses the api.proto file which can be found on the protocol github repo to generate Rust using prost (which implements protobuf).

Modules

boot_status
close_channel
close_channel_res
command
container_state
file
file_event
open_channel
open_channel_res
ot_rune_transform_op
pprof_request
vcr_entry

Structs

AppendMeta
Audio
Audio2
Auth
BootStatus
ChatMessage
ChatScrollback
ChatTyping
CheckChanges
Clear

Service specific:

CloseChannel

Used to either close a channel or diconnect from an attached channel. The channel which is being effected should have its id provided. Note that if the global channel (with id 0) is provided, nothing will happen.

CloseChannelRes

Used to determine whether a channel was or wasn't successfully closed or disconnected. This will contain the state of the channels closure or disconnection, and whether nothing happened.

Command

This is the structure of all sent and received messages. It provides a reusable interface for both the client and container to use.

Connect
ContainedTest
ContainerState

Used to notify the client about current state of the container. This is usually received along with the response of service commands.

Debug
DebugStatus
Disconnect
EnsurePackages
Exec
ExecInfo
File
FileAuthReq
FileAuthRes
FileEvent
Files
Flush
FsLock
FsSnapshot
Goodbye
Hello
Hint
LintResult
LintResults
ListObjects
ListObjectsResp
Metrics
Move
MultiFileAuthRes
Ok

Used to signify that the service completed the action successfully.

OpenChannel

Used to either create a new channel or attach to an existing channel. A channel with the name set to "", which is the same as having it unset, is called an anonymous channel. Anonymous channels cannot be attached to, unlike named channels.

OpenChannelRes

Used to determine whether a channel was or wasn't successfully created. This will contain the state of the channels creation, along with it's id or an error if there were any problems.

OtCursor
OtFetchRequest
OtFetchResponse
OtLinkFile
OtPacket
OtRuneTransformOp
OtStatus
Package
PackageAdd
PackageCacheSave
PackageInfo
PackageInfoResp
PackageInstall
PackageListSpecfile
PackageListSpecfileResp
PackageRemove
PackageSearch
PackageSearchResp
Pid1Config
Ping
Pong
PortOpen

Used to notify the client about the current address and port which the container is listening on. This is received when the container listens on the network.

PprofAllocsProfileRequest
PprofBlockProfileRequest
PprofCpuProfileRequest
PprofHeapProfileRequest
PprofMutexProfileRequest
PprofRequest
PprofResponse
PtyConfig

Message used to configure PTY

ReadMeta
ReadVcr
Recv
Redirect

Redirect indicates that a client should attempt to connect through another URL. This is needed since most browser WebSockets implementations do not support following standard HTTP redirects.

ResizeTerm
Roster
RunMain
SaneTerm
Send
StackFrame
Start
StartVcr
SubscribeFile
TestFailure
TestResult
Toast

Used to "send lil notifications to the client", this includes things such as human readable wanings.

User
VcrEntry
VcrLog
WriteMeta

Enums

FileAuthMethod
State

Used to signify the state of the service.