Expand description
Types for the WebSocket API. Types for the websocket server.
Structs§
- ApiError
- An error.
- Client
Metrics - ClientMetrics contains information regarding the state of the peer.
- Failure
WebSocket Response - Unsuccessful Websocket response.
- IceServer
- 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
- Loggable
ApiError - An error with an internal message for logging.
- Modeling
Batch - A sequence of modeling requests. If any request fails, following requests will not be tried.
- Modeling
CmdReq - A graphics command submitted to the KittyCAD engine via the Modeling API.
- Modeling
Session Data - Successful Websocket response.
- RawFile
- 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.
- RtcIce
Candidate - ICECandidate represents a ice candidate
- RtcIce
Candidate Init - ICECandidateInit is used to serialize ice candidates
- RtcSession
Description - SessionDescription is used to expose local and remote session descriptions.
- Success
WebSocket Response - Successful Websocket response.
Enums§
- Batch
Response - Websocket responses can either be successful or unsuccessful. Slightly different schemas in either case.
- Error
Code - The type of error sent by the KittyCAD API.
- OkWeb
Socket Response Data - The websocket messages this server sends.
- RtcIce
Candidate Type - ICECandidateType represents the type of the ICE candidate used.
- RtcIce
Protocol - ICEProtocol indicates the transport protocol type that is used in the ice.URL structure.
- RtcSdp
Type - SDPType describes the type of an SessionDescription.
- Snake
Case Result - Serde serializes Result into JSON as “Ok” and “Err”, but we want “ok” and “err”. So, create a new enum that serializes as lowercase.
- WebSocket
Request - The websocket messages the server receives.
- WebSocket
Response - Websocket responses can either be successful or unsuccessful. Slightly different schemas in either case.