oracledb 26.0.0-beta.1

Lightweight driver for Oracle Database
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//-----------------------------------------------------------------------------
// Copyright (c) 2026, Oracle and/or its affiliates.
//
// This software is dual-licensed to you under the Universal Permissive License
// (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
// 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
// either license.
//
// If you elect to accept the software under the Apache License, Version 2.0,
// the following applies:
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------
// protocol.rs
//
// Defines the structure used for sending and receiving the protocol message.
// This is the second message sent to the database while establishing a
// connection and can be combined with the data types and auth messages when
// fast authentication is available.
// -----------------------------------------------------------------------------

use crate::client::Client;
use crate::constants;
use crate::error::Error;
use crate::messages::Message;
use crate::response::Response;
use crate::write_buffer::WriteBuffer;

pub struct ProtocolMessage {
    charset_id: u16,
    ncharset_id: u16,
    server_compile_caps: Vec<u8>,
    server_runtime_caps: Vec<u8>,
}

impl ProtocolMessage {
    pub fn new() -> ProtocolMessage {
        ProtocolMessage {
            charset_id: 0,
            ncharset_id: 0,
            server_compile_caps: Vec::<u8>::new(),
            server_runtime_caps: Vec::<u8>::new(),
        }
    }

    fn skip_array(&mut self, resp: &mut Response) -> Result<(), Error> {
        loop {
            let byte = resp.read_u8()?;
            if byte == 0 {
                break;
            }
        }
        Ok(())
    }
}

impl Message for ProtocolMessage {
    fn deserialize_ttc_message(
        &mut self,
        _client: &Client,
        resp: &mut Response,
        message_type: u8,
    ) -> Result<(), Error> {
        if message_type != constants::TTC_MSG_TYPE_PROTOCOL {
            return Err(Error::unknown_ttc_message_type(message_type));
        }
        self.skip_array(resp)?; // protocol message version
        self.skip_array(resp)?; // server banner
        self.charset_id = resp.read_u16le()?;
        resp.advance(1)?; // skip server flags
        let num_elem = resp.read_u16le()?;
        if num_elem > 0 {
            let graph_len: usize = (num_elem * 5).into();
            resp.advance(graph_len)?; // character set graph
        }
        let fdo_len = resp.read_u16be()? as usize;
        resp.advance(5)?; // skip first part of FDO
        let offset1 = resp.read_u8()? as usize;
        let offset2 = resp.read_u8()? as usize;
        resp.advance(offset1 + offset2)?;
        self.ncharset_id = resp.read_u16be()?;
        resp.advance(fdo_len - offset1 - offset2 - 9)?;
        self.server_compile_caps = resp.read_bytes_with_length()?.into();
        self.server_runtime_caps = resp.read_bytes_with_length()?.into();
        Ok(())
    }

    fn is_final_ttc_message_type(
        &self,
        _client: &Client,
        _message_type: u8,
    ) -> bool {
        true
    }

    /// Called after the message has been deserialized. The capabilities of the
    /// client are adjusted based on the capabilities of the server.
    fn post_deserialize(
        &mut self,
        client: &mut Client,
        _resp: &mut Response,
    ) -> Result<(), Error> {
        client.set_charset_ids(self.charset_id, self.ncharset_id);
        if !self.server_compile_caps.is_empty() {
            client.adjust_for_server_compile_caps(&self.server_compile_caps);
        }
        if !self.server_runtime_caps.is_empty() {
            client.adjust_for_server_runtime_caps(&self.server_runtime_caps);
        }
        Ok(())
    }

    fn serialize(&self, _client: &Client, buf: &mut WriteBuffer) {
        buf.write_u8(constants::TTC_MSG_TYPE_PROTOCOL);
        buf.write_u8(6); // protocol message version
        buf.write_u8(0); // "array" terminator
        buf.write_str(constants::DRIVER_NAME);
        buf.write_u8(0); // "NULL" terminator
    }
}