Skip to content

Latest commit

 

History

History
157 lines (111 loc) · 5.02 KB

CHANGELOG.md

File metadata and controls

157 lines (111 loc) · 5.02 KB

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. The file is auto-generated using Conventional Commits.

Overview

[Unreleased]

nothing new to show for… yet!

2021.10.14

Changes

  • Rename Socket to Client and SocketBuilder to ClientBuilder

  • Removed headermap from pub use, internal type only

  • Deprecations:

    • crate::payload (use crate::Payload instead)
    • crate::error (use crate::Error instead)
    • crate::event (use crate::Event instead)

2021.09.20

Changes

  • Refactored Errors
    • Renamed EmptyPacket to EmptyPacket()
    • Renamed IncompletePacket to IncompletePacket()
    • Renamed InvalidPacket to InvalidPacket()
    • Renamed Utf8Error to InvalidUtf8()
    • Renamed Base64Error to InvalidBase64
    • Renamed InvalidUrl to InvalidUrlScheme
    • Renamed ReqwestError to IncompleteResponseFromReqwest
    • Renamed HttpError to IncompleteHttp
    • Renamed HandshakeError to InvalidHandshake
    • Renamed ActionBeforeOpen to IllegalActionBeforeOpen()
    • Renamed DidNotReceiveProperAck to MissingAck
    • Renamed PoisonedLockError to InvalidPoisonedLock
    • Renamed FromWebsocketError to IncompleteResponseFromWebsocket
    • Renamed FromWebsocketParseError to InvalidWebsocketURL
    • Renamed FromIoError to IncompleteIo
    • New error type InvalidUrl(UrlParseError)
    • New error type InvalidInteger(ParseIntError)
    • New error type IncompleteResponseFromEngineIo(rust_engineio::Error)
    • New error type InvalidAttachmentPacketType(u8)
    • Removed EmptyPacket
  • Refactored Packet
    • Renamed encode to From<&Packet>
    • Renamed decode to TryFrom<&Bytes>
    • Renamed attachments to attachments_count
    • New struct member attachments: Option<Vec>
  • Refactor PacketId
    • Renamed u8_to_packet_id to TryFrom for PacketId
  • Refactored SocketBuilder
    • Renamed set_namespace to namespace
    • Renamed set_tls_config to tls_config
    • Renamed set_opening_header to opening_header
    • namespace returns Self rather than Result
    • opening_header accepts a Into rather than HeaderValue
  • Allows for pure websocket connections
  • Refactor EngineIO module

2021.05.25

Changes

  • Fixed a bug that prevented the client from receiving data for a message event issued on the server.

2021.05.24

Changes

  • Added a disconnect method to the Socket struct as requested in #43.

2021.05.13

Changes

  • Added websocket communication over TLS when either wss, or https are specified in the URL.
  • Added the ability to configure the TLS connection by providing an own TLSConnector.
  • Added the ability to set custom headers as requested in #35.

2021.04.27

Changes

  • Corrected memory odering issues which might have become an issue on certain platforms.
  • Added this CHANGELOG to keep track of all changes.
  • Small stylistic changes to the codebase in general.

2021.03.13

Changes

  • Moved from async rust to sync rust.
  • Implemented the missing protocol features.
    • Websocket as a transport layer.
    • Binary payload.
  • Added a SocketBuilder class to easily configure a connected client.
  • Added a new Payload type to manage the binary and string payload.

2021.01.10

Changes

  • Bumped tokio to version 1.0.*, and therefore reqwest to 0.11.*.
  • Removed all unsafe code.

2021.01.05

  • First version of the libary written in async rust. The features included:
    • connecting to a server.
    • register callbacks for the following event types:
      • open, close, error, message
    • custom events like "foo", "on_payment", etc.
    • send json-data to the server (recommended to use serde_json as it provides safe handling of json data).
    • send json-data to the server and receive an ack with a possible message.