Warning: This project is currently in an experimental state. Its API may change unpredictably and incompatibly.
About Rust-WebSocket
Rust-WebSocket is a WebSocket (RFC6455) library written in Rust.
Rust-WebSocket provides a framework for dealing with WebSocket connections (both clients and servers). The library is currently in an experimental state, but provides functionality for both normal and secure WebSockets, a message level API supporting fragmentation, a data frame level API, and the ability to extend and customize behaviour.
The project can be found on GitHub and on crates.io.
Licence
Rust-WebSocket is provided under the MIT licence.
The MIT License (MIT)
Copyright (c) 2014-2015 Cyderize
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Installation
To add a library release version from crates.io to a Cargo project, add this to the [dependencies] section of your Cargo.toml:
websocket = "~"To add the library's Git repository to a Cargo project, add this to your Cargo.toml:
[dependencies.websocket]
git = "https://github.com/cyderize/rust-websocket.git"And add the line extern crate websocket; to your main.rs or lib.rs.
Current State
See the README on GitHub for information on the current state of Rust-WebSocket.
Documentation
API Documentation for the library can be found here. Example usage can be found within the documentation.
If you have additional enquiries regarding the library or myself, contact me here.
Protocol Conformance
Rust-WebSocket verifies its implementation using the Autobahn TestSuite. The results of these tests can be found here.