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§
- ColMeta
Data - Column metadata token.
- Collation
- SQL Server collation.
- Column
Data - Column definition within metadata.
- Done
- Done token indicating statement completion.
- Done
InProc - Done in procedure token.
- Done
Proc - Done procedure token.
- Done
Status - Done status flags.
- EnvChange
- Environment change token.
- Feature
Ack - Individual feature acknowledgment.
- Feature
ExtAck - Feature extension acknowledgment.
- FedAuth
Info - Federated authentication info.
- Login
Ack - Login acknowledgment token.
- NbcRow
- Null bitmap compressed row.
- Order
- Column ordering information.
- RawRow
- Raw row data (not yet decoded).
- Return
Value - Return value from stored procedure.
- Server
Error - Server error message.
- Server
Info - Server informational message.
- Session
State - Session state token.
- Sspi
Token - SSPI authentication token.
- Token
Parser - Token stream parser.
- Type
Info - Type-specific metadata.
Enums§
- EnvChange
Type - Environment change type.
- EnvChange
Value - Environment change value.
- Token
- Parsed TDS token.
- Token
Type - Token type identifier.