Package ( `bformat`)

- Updated comment for `bformat.client`

- Renamed `sockets` module to `client` module
This commit is contained in:
Tristan B. Velloza Kildaire 2023-04-30 12:49:13 +02:00
parent 00664bd844
commit e1a167fdbf
2 changed files with 9 additions and 12 deletions

View File

@ -1,12 +1,16 @@
/**
* Socket encoding/decoding functions
*/
module bformat.sockets;
module bformat.client;
import std.socket : Socket;
import river.core;
import river.impls.sock : SockStream;
/**
* Bformat client to encode and decode via a
* `Socket` or river-based `Stream`
*/
public class BClient
{
/**

View File

@ -4,18 +4,11 @@
module bformat;
/**
* Encodes the provided message into the bformat format
* and sends it over the provided socket
* Provides a client which consumes a stream
* which can encode and decode messages to
* and from it
*/
public import bformat.sockets : BClient;
/**
* Receives a message from the provided socket
* by decoding the streamed bytes into bformat
* and finally placing the resulting payload in
* the provided array
*/
// public import bformat.sockets : receiveMessage;
public import bformat.client : BClient;
/**
* Encodes the provided message into the bformat format