refactor: get rid of lazy_static (#1022)

Author: RRRadicalEdward

Cargo.lock

@@ -39,7 +39,6 @@ rstest = "0.25"
 # Note: we are trying to move away from using these crates.
 # They are being kept around for now for legacy compatibility,
 # but new usage should be avoided.
-lazy_static = "1.4" # Legacy crate; prefer std::sync::LazyLock or LazyCell
 num-derive = "0.4"
 num-traits = "0.2"
 

Cargo.toml

@@ -22,7 +22,6 @@ bitvec = "1.0"
 ironrdp-core = { path = "../ironrdp-core", version = "0.1" } # public
 ironrdp-pdu = { path = "../ironrdp-pdu", version = "0.6", features = ["std"] } # public
 byteorder = "1.5" # TODO: remove
-lazy_static.workspace = true # Legacy crate; prefer std::sync::LazyLock or LazyCell
 num-derive.workspace = true # TODO: remove
 num-traits.workspace = true # TODO: remove
 yuv = { version = "0.8", features = ["rdp"] }

crates/ironrdp-graphics/Cargo.toml

@@ -400,88 +400,86 @@ fn bands_internals_equal(first_band: &[InclusiveRectangle], second_band: &[Inclu
 
 #[cfg(test)]
 mod tests {
- use lazy_static::lazy_static;
+ use std::sync::LazyLock;
 
  use super::*;
 
- lazy_static! {
- static ref REGION_FOR_RECTANGLES_INTERSECTION: Region = Region {
- extents: InclusiveRectangle {
+ static REGION_FOR_RECTANGLES_INTERSECTION: LazyLock<Region> = LazyLock::new(|| Region {
+ extents: InclusiveRectangle {
+ left: 1,
+ top: 1,
+ right: 11,
+ bottom: 9,
+ },
+ rectangles: vec![
+ InclusiveRectangle {
  left: 1,
  top: 1,
+ right: 5,
+ bottom: 3,
+ },
+ InclusiveRectangle {
+ left: 7,
+ top: 1,
+ right: 8,
+ bottom: 3,
+ },
+ InclusiveRectangle {
+ left: 9,
+ top: 1,
  right: 11,
+ bottom: 3,
+ },
+ InclusiveRectangle {
+ left: 7,
+ top: 3,
+ right: 11,
+ bottom: 4,
+ },
+ InclusiveRectangle {
+ left: 3,
+ top: 4,
+ right: 6,
+ bottom: 6,
+ },
+ InclusiveRectangle {
+ left: 7,
+ top: 4,
+ right: 11,
+ bottom: 6,
+ },
+ InclusiveRectangle {
+ left: 1,
+ top: 6,
+ right: 3,
+ bottom: 8,
+ },
+ InclusiveRectangle {
+ left: 4,
+ top: 6,
+ right: 5,
+ bottom: 8,
+ },
+ InclusiveRectangle {
+ left: 6,
+ top: 6,
+ right: 10,
+ bottom: 8,
+ },
+ InclusiveRectangle {
+ left: 4,
+ top: 8,
+ right: 5,
  bottom: 9,
  },
- rectangles: vec![
- InclusiveRectangle {
- left: 1,
- top: 1,
- right: 5,
- bottom: 3,
- },
- InclusiveRectangle {
- left: 7,
- top: 1,
- right: 8,
- bottom: 3,
- },
- InclusiveRectangle {
- left: 9,
- top: 1,
- right: 11,
- bottom: 3,
- },
- InclusiveRectangle {
- left: 7,
- top: 3,
- right: 11,
- bottom: 4,
- },
- InclusiveRectangle {
- left: 3,
- top: 4,
- right: 6,
- bottom: 6,
- },
- InclusiveRectangle {
- left: 7,
- top: 4,
- right: 11,
- bottom: 6,
- },
- InclusiveRectangle {
- left: 1,
- top: 6,
- right: 3,
- bottom: 8,
- },
- InclusiveRectangle {
- left: 4,
- top: 6,
- right: 5,
- bottom: 8,
- },
- InclusiveRectangle {
- left: 6,
- top: 6,
- right: 10,
- bottom: 8,
- },
- InclusiveRectangle {
- left: 4,
- top: 8,
- right: 5,
- bottom: 9,
- },
- InclusiveRectangle {
- left: 6,
- top: 8,
- right: 10,
- bottom: 9,
- },
- ],
- };
- }
+ InclusiveRectangle {
+ left: 6,
+ top: 8,
+ right: 10,
+ bottom: 9,
+ },
+ ],
+ });
 
  #[test]
  fn union_rectangle_sets_extents_and_single_rectangle_for_empty_region() {

crates/ironrdp-graphics/src/rectangle_processing.rs

@@ -84,7 +84,7 @@ bitflags! {
 
 #[cfg(test)]
 mod test {
- use lazy_static::lazy_static;
+ use std::sync::LazyLock;
 
  use super::*;
 
@@ -111,29 +111,30 @@ mod test {
  0x02, // the third segment: data
  ];
 
- lazy_static! {
- static ref SINGLE_SEGMENTED_DATA_PDU: SegmentedDataPdu<'static> = SegmentedDataPdu::Single(BulkEncodedData {
+ static SINGLE_SEGMENTED_DATA_PDU: LazyLock<SegmentedDataPdu<'static>> = LazyLock::new(|| {
+ SegmentedDataPdu::Single(BulkEncodedData {
  compression_flags: CompressionFlags::COMPRESSED,
  data: &SINGLE_SEGMENTED_DATA_PDU_BUFFER[2..],
- });
- static ref MULTIPART_SEGMENTED_DATA_PDU: SegmentedDataPdu<'static> = SegmentedDataPdu::Multipart {
+ })
+ });
+ static MULTIPART_SEGMENTED_DATA_PDU: LazyLock<SegmentedDataPdu<'static>> =
+ LazyLock::new(|| SegmentedDataPdu::Multipart {
  uncompressed_size: 0x2B,
  segments: vec![
  BulkEncodedData {
  compression_flags: CompressionFlags::empty(),
- data: &MULTIPART_SEGMENTED_DATA_PDU_BUFFER[12..12 + 16]
+ data: &MULTIPART_SEGMENTED_DATA_PDU_BUFFER[12..12 + 16],
  },
  BulkEncodedData {
  compression_flags: CompressionFlags::empty(),
- data: &MULTIPART_SEGMENTED_DATA_PDU_BUFFER[33..33 + 13]
+ data: &MULTIPART_SEGMENTED_DATA_PDU_BUFFER[33..33 + 13],
  },
  BulkEncodedData {
  compression_flags: CompressionFlags::COMPRESSED,
- data: &MULTIPART_SEGMENTED_DATA_PDU_BUFFER[51..]
+ data: &MULTIPART_SEGMENTED_DATA_PDU_BUFFER[51..],
  },
  ],
- };
- }
+ });
 
  #[test]
  fn from_buffer_correctly_parses_zgfx_single_segmented_data_pdu() {

crates/ironrdp-graphics/src/zgfx/control_messages.rs

@@ -4,6 +4,7 @@ mod circular_buffer;
 mod control_messages;
 
 use std::io::{self, Write as _};
+use std::sync::LazyLock;
 
 use bitvec::bits;
 use bitvec::field::BitField as _;
@@ -223,8 +224,8 @@ enum TokenType {
  },
 }
 
-lazy_static::lazy_static! {
- static ref TOKEN_TABLE: [Token; 40] = [
+static TOKEN_TABLE: LazyLock<[Token; 40]> = LazyLock::new(|| {
+ [
  Token {
  prefix: bits![static u8, Msb0; 0],
  ty: TokenType::NullLiteral,
@@ -427,8 +428,8 @@ lazy_static::lazy_static! {
  distance_base: 17_094_304,
  },
  },
- ];
-}
+ ]
+});
 
 #[derive(Debug)]
 pub enum ZgfxError {

crates/ironrdp-graphics/src/zgfx/mod.rs

@@ -44,7 +44,6 @@ pkcs1 = "0.7"
 
 [dev-dependencies]
 expect-test.workspace = true
-lazy_static.workspace = true # TODO: remove in favor of https://doc.rust-lang.org/std/sync/struct.OnceLock.html
 
 [lints]
 workspace = true

crates/ironrdp-pdu/Cargo.toml

@@ -1,5 +1,6 @@
+use std::sync::LazyLock;
+
 use ironrdp_core::{decode, encode};
-use lazy_static::lazy_static;
 
 use super::*;
 
@@ -31,31 +32,29 @@ const BITMAP_BUFFER: [u8; 114] = [
  0x55, 0xad, 0x10, 0x10, 0xa8, 0xd8, 0x60, 0x12,
 ];
 
-lazy_static! {
- static ref BITMAP: BitmapUpdateData<'static> = BitmapUpdateData {
- rectangles: {
- let vec = vec![BitmapData {
- rectangle: InclusiveRectangle {
- left: 1792,
- top: 1024,
- right: 1855,
- bottom: 1079,
- },
- width: 64,
- height: 56,
- bits_per_pixel: 16,
- compression_flags: Compression::BITMAP_COMPRESSION,
- compressed_data_header: Some(CompressedDataHeader {
- main_body_size: 80,
- scan_width: 28,
- uncompressed_size: 4,
- }),
- bitmap_data: &BITMAP_BUFFER[30..],
- }];
- vec
- }
- };
-}
+static BITMAP: LazyLock<BitmapUpdateData<'static>> = LazyLock::new(|| BitmapUpdateData {
+ rectangles: {
+ let vec = vec![BitmapData {
+ rectangle: InclusiveRectangle {
+ left: 1792,
+ top: 1024,
+ right: 1855,
+ bottom: 1079,
+ },
+ width: 64,
+ height: 56,
+ bits_per_pixel: 16,
+ compression_flags: Compression::BITMAP_COMPRESSION,
+ compressed_data_header: Some(CompressedDataHeader {
+ main_body_size: 80,
+ scan_width: 28,
+ uncompressed_size: 4,
+ }),
+ bitmap_data: &BITMAP_BUFFER[30..],
+ }];
+ vec
+ },
+});
 
 #[test]
 fn from_buffer_bitmap_data_parsses_correctly() {

crates/ironrdp-pdu/src/basic_output/bitmap/tests.rs

@@ -1,5 +1,6 @@
+use std::sync::LazyLock;
+
 use ironrdp_core::{decode, encode};
-use lazy_static::lazy_static;
 
 use super::*;
 
@@ -29,15 +30,13 @@ const FAST_PATH_HEADER_WITH_FORCED_LONG_LEN_PDU: FastPathHeader = FastPathHeader
  forced_long_length: true,
 };
 
-lazy_static! {
- static ref FAST_PATH_UPDATE_PDU: FastPathUpdatePdu<'static> = FastPathUpdatePdu {
- fragmentation: Fragmentation::Single,
- update_code: UpdateCode::SurfaceCommands,
- compression_flags: None,
- compression_type: None,
- data: &FAST_PATH_UPDATE_PDU_BUFFER[3..],
- };
-}
+static FAST_PATH_UPDATE_PDU: LazyLock<FastPathUpdatePdu<'static>> = LazyLock::new(|| FastPathUpdatePdu {
+ fragmentation: Fragmentation::Single,
+ update_code: UpdateCode::SurfaceCommands,
+ compression_flags: None,
+ compression_type: None,
+ data: &FAST_PATH_UPDATE_PDU_BUFFER[3..],
+});
 
 #[test]
 fn from_buffer_correctly_parses_fast_path_header_with_short_length() {