Std.Db.Protocol

26 public declarations

• authenticationKind&Bytes -> Result[Int, Std.Db.Protocol.ProtocolError]

  What kind of authentication the server asked for, read from the message

  fn
• bindStr -> Str -> &Array[Option[Str]] -> Bytes

  Values supplied for a planned statement's holes.

  fn
• bodyLength&Bytes -> Option[Int]

  How many bytes a message needs beyond the five already read, or nothing

  fn
• Column

  A column the server says a result will have.

  type
• cStringStr -> Bytes

  Text with the zero byte the protocol ends a string with.

  fn
• describeStatementStr -> Bytes

  Ask what shape a planned statement produces.

  fn
• executeStr -> Int -> Bytes

  Run a bound statement, with no limit on how many rows come back.

  fn
• fieldOf&Array[(Str, Str)] -> Str -> Str

  One field of an error, by the letter naming it.

  fn
• frameStr -> &Bytes -> Bytes

  A message framed the way the protocol frames one: the letter, then the

  fn
• Message

  One message, as it travels: the letter naming its kind and the bytes after

  type
• messageSize&Bytes -> Result[Int, Std.Db.Protocol.ProtocolError]

  Validate the length before a streaming reader allocates or requests a body.

  fn
• parseStr -> Str -> Bytes

  A statement given to the server to plan, with the values left as holes.

  fn
• passwordStr -> Bytes

  A password sent as the server asked for it.

  fn
• ProtocolError

  Why bytes on the wire did not make a message.

  type
• queryStr -> Bytes

  A simple query, which asks the server to plan and run text in one step.

  fn
• readCString&Bytes -> Result[(Str, Bytes), Std.Db.Protocol.ProtocolError]

  The text at the front of a payload, and what follows it.

  fn
• readDataRow&Bytes -> Result[Array[Option[Str]], Std.Db.Protocol.ProtocolError]

  SQL NULL has one explicit sentinel; invalid or truncated text is not absent.

  fn
• readFields&Bytes -> Array[(Str, Str)]

  The fields an error or notice carries, keyed by the letter naming each.

  fn
• readMessage&Bytes -> Result[(Std.Db.Protocol.Message, Bytes), Std.Db.Protocol.ProtocolError]

  Read one complete message, preserving any following frames.

  fn
• readRowDescription&Bytes -> Result[Array[Std.Db.Protocol.Column], Std.Db.Protocol.ProtocolError]

  The columns a row description names.

  fn
• saslInitialStr -> Str -> Bytes

  The first message of a challenge, naming the mechanism and the opening

  fn
• saslResponseStr -> Bytes

  A later message of a challenge, which carries only its text.

  fn
• startup&Array[(Str, Str)] -> Bytes

  The first message a connection sends, which carries no letter.

  fn
• syncBytes

  End the sequence, so the server reports and becomes ready again.

  fn
• terminateBytes

  Say the connection is finished.

  fn
• VERSIONInt

  The version this speaks: the third revision of the protocol, written as a

  const