Module token

Module token 

Source
Expand description

TDS token stream definitions.

Tokens are the fundamental units of TDS response data. The server sends a stream of tokens that describe metadata, rows, errors, and other information.

§Token Structure

Each token begins with a 1-byte token type identifier, followed by token-specific data. Some tokens have fixed lengths, while others have length prefixes.

§Usage

use tds_protocol::token::{Token, TokenParser};
use bytes::Bytes;

let data: Bytes = /* received from server */;
let mut parser = TokenParser::new(data);

while let Some(token) = parser.next_token()? {
    match token {
        Token::Done(done) => println!("Rows affected: {}", done.row_count),
        Token::Error(err) => eprintln!("Error {}: {}", err.number, err.message),
        _ => {}
    }
}

Structs§

ColMetaData
Column metadata token.
Collation
SQL Server collation.
ColumnData
Column definition within metadata.
Done
Done token indicating statement completion.
DoneInProc
Done in procedure token.
DoneProc
Done procedure token.
DoneStatus
Done status flags.
EnvChange
Environment change token.
FeatureAck
Individual feature acknowledgment.
FeatureExtAck
Feature extension acknowledgment.
FedAuthInfo
Federated authentication info.
LoginAck
Login acknowledgment token.
NbcRow
Null bitmap compressed row.
Order
Column ordering information.
RawRow
Raw row data (not yet decoded).
ReturnValue
Return value from stored procedure.
ServerError
Server error message.
ServerInfo
Server informational message.
SessionState
Session state token.
SspiToken
SSPI authentication token.
TokenParser
Token stream parser.
TypeInfo
Type-specific metadata.

Enums§

EnvChangeType
Environment change type.
EnvChangeValue
Environment change value.
Token
Parsed TDS token.
TokenType
Token type identifier.