From 739d9ab34a07e2fb3f973bc57a3bc9451cd61921 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Sat, 27 Apr 2024 15:55:01 -0700 Subject: [PATCH] re-exposes CBORCoder and associated documentation --- .../Documentation.docc/Curation/CBORCoder.md | 11 +++++++++++ .../AutomergeRepo/Documentation.docc/Documentation.md | 1 + Sources/AutomergeRepo/Sync/CBORCoder.swift | 6 ++++-- 3 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 Sources/AutomergeRepo/Documentation.docc/Curation/CBORCoder.md diff --git a/Sources/AutomergeRepo/Documentation.docc/Curation/CBORCoder.md b/Sources/AutomergeRepo/Documentation.docc/Curation/CBORCoder.md new file mode 100644 index 0000000..eab77aa --- /dev/null +++ b/Sources/AutomergeRepo/Documentation.docc/Curation/CBORCoder.md @@ -0,0 +1,11 @@ +# ``AutomergeRepo/CBORCoder`` + +## Topics + +### Accessing a CBOR encoder + +- ``CBORCoder/encoder`` + +### Accessing a CBOR decoder + +- ``CBORCoder/decoder`` diff --git a/Sources/AutomergeRepo/Documentation.docc/Documentation.md b/Sources/AutomergeRepo/Documentation.docc/Documentation.md index 1c87b74..f3d4150 100644 --- a/Sources/AutomergeRepo/Documentation.docc/Documentation.md +++ b/Sources/AutomergeRepo/Documentation.docc/Documentation.md @@ -58,6 +58,7 @@ The peer-to-peer provider uses of Apple's Bonjour technology to connect to other - ``AutomergeRepo/PEER_ID`` - ``AutomergeRepo/STORAGE_ID`` - ``AutomergeRepo/SYNC_MESSAGE`` +- ``CBORCoder`` ### Share Policy diff --git a/Sources/AutomergeRepo/Sync/CBORCoder.swift b/Sources/AutomergeRepo/Sync/CBORCoder.swift index 31c8696..bff0d7b 100644 --- a/Sources/AutomergeRepo/Sync/CBORCoder.swift +++ b/Sources/AutomergeRepo/Sync/CBORCoder.swift @@ -1,8 +1,10 @@ import Foundation import PotentCBOR -/// A type that provides concurrency-safe access to the CBOR encoder and decoder. -actor CBORCoder { +/// A type that provides concurrency-safe access to a CBOR encoder and decoder. +public actor CBORCoder { + /// A CBOR encoder public static let encoder = CBOREncoder() + /// A CBOR decoder public static let decoder = CBORDecoder() }