Module kittycad_modeling_cmds::websocket
source · Expand description
Types for the WebSocket API. Types for the websocket server.
Structs§
- An error.
- ClientMetrics contains information regarding the state of the peer.
- Unsuccessful Websocket response.
- Representation of an ICE server used for STUN/TURN Used to initiate WebRTC connections based on https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer
- An error with an internal message for logging.
- A sequence of modeling requests. If any request fails, following requests will not be tried.
- A graphics command submitted to the KittyCAD engine via the Modeling API.
- A raw file with unencoded contents to be passed over binary websockets. When raw files come back for exports it is sent as binary/bson, not text/json.
- ICECandidate represents a ice candidate
- ICECandidateInit is used to serialize ice candidates
- SessionDescription is used to expose local and remote session descriptions.
- Successful Websocket response.
Enums§
- Websocket responses can either be successful or unsuccessful. Slightly different schemas in either case.
- The type of error sent by the KittyCAD API.
- The websocket messages this server sends.
- ICECandidateType represents the type of the ICE candidate used.
- ICEProtocol indicates the transport protocol type that is used in the ice.URL structure.
- SDPType describes the type of an SessionDescription.
- Serde serializes Result into JSON as “Ok” and “Err”, but we want “ok” and “err”. So, create a new enum that serializes as lowercase.
- The websocket messages the server receives.
- Websocket responses can either be successful or unsuccessful. Slightly different schemas in either case.