Expose build info

Allows client to access the version specified in Cargo.toml

Author: ladvoc

livekit-uniffi/generated/kotlin/uniffi/livekit_uniffi/livekit_uniffi.kt

@@ -640,6 +640,8 @@ internal object IntegrityCheckingUniffiLib {
         uniffiCheckContractApiVersion(this)
         uniffiCheckApiChecksums(this)
     }
+    external fun uniffi_livekit_uniffi_checksum_func_build_version(
+    ): Short
     external fun uniffi_livekit_uniffi_checksum_func_generate_token(
     ): Short
     external fun uniffi_livekit_uniffi_checksum_func_log_forward_bootstrap(
@@ -661,6 +663,8 @@ internal object UniffiLib {
         Native.register(UniffiLib::class.java, findLibraryName(componentName = "livekit_uniffi"))
 
     }
+    external fun uniffi_livekit_uniffi_fn_func_build_version(uniffi_out_err: UniffiRustCallStatus, 
+    ): RustBuffer.ByValue
     external fun uniffi_livekit_uniffi_fn_func_generate_token(`options`: RustBuffer.ByValue,`credentials`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
     ): RustBuffer.ByValue
     external fun uniffi_livekit_uniffi_fn_func_log_forward_bootstrap(`level`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
@@ -788,6 +792,9 @@ private fun uniffiCheckContractApiVersion(lib: IntegrityCheckingUniffiLib) {
 }
 @Suppress("UNUSED_PARAMETER")
 private fun uniffiCheckApiChecksums(lib: IntegrityCheckingUniffiLib) {
+    if (lib.uniffi_livekit_uniffi_checksum_func_build_version() != 45072.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_livekit_uniffi_checksum_func_generate_token() != 29823.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
@@ -1962,6 +1969,19 @@ public object FfiConverterMapStringString: FfiConverterRustBuffer<Map<kotlin.Str
 
 
 
+        /**
+         * Returns the version specified in the crate's Cargo.toml.
+         */ fun `buildVersion`(): kotlin.String {
+            return FfiConverterString.lift(
+    uniffiRustCall() { _status ->
+    UniffiLib.uniffi_livekit_uniffi_fn_func_build_version(
+    
+        _status)
+}
+    )
+    }
+    
+
         /**
          * Generates an access token.
          *

livekit-uniffi/generated/python/livekit_uniffi.py

@@ -479,6 +479,8 @@ def _uniffi_check_contract_api_version(lib):
         raise InternalError("UniFFI contract version mismatch: try cleaning and rebuilding your project")
 
 def _uniffi_check_api_checksums(lib):
+    if lib.uniffi_livekit_uniffi_checksum_func_build_version() != 45072:
+        raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_livekit_uniffi_checksum_func_generate_token() != 29823:
         raise InternalError("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     if lib.uniffi_livekit_uniffi_checksum_func_log_forward_bootstrap() != 14091:
@@ -750,6 +752,10 @@ class _UniffiForeignFutureDroppedCallbackStruct(ctypes.Structure):
     ctypes.c_uint64,
 )
 _UniffiLib.ffi_livekit_uniffi_rust_future_free_void.restype = None
+_UniffiLib.uniffi_livekit_uniffi_fn_func_build_version.argtypes = (
+    ctypes.POINTER(_UniffiRustCallStatus),
+)
+_UniffiLib.uniffi_livekit_uniffi_fn_func_build_version.restype = _UniffiRustBuffer
 _UniffiLib.uniffi_livekit_uniffi_fn_func_generate_token.argtypes = (
     _UniffiRustBuffer,
     _UniffiRustBuffer,
@@ -773,6 +779,9 @@ class _UniffiForeignFutureDroppedCallbackStruct(ctypes.Structure):
 _UniffiLib.ffi_livekit_uniffi_uniffi_contract_version.argtypes = (
 )
 _UniffiLib.ffi_livekit_uniffi_uniffi_contract_version.restype = ctypes.c_uint32
+_UniffiLib.uniffi_livekit_uniffi_checksum_func_build_version.argtypes = (
+)
+_UniffiLib.uniffi_livekit_uniffi_checksum_func_build_version.restype = ctypes.c_uint16
 _UniffiLib.uniffi_livekit_uniffi_checksum_func_generate_token.argtypes = (
 )
 _UniffiLib.uniffi_livekit_uniffi_checksum_func_generate_token.restype = ctypes.c_uint16
@@ -1880,6 +1889,20 @@ def read(buf):
     @staticmethod
     def write(value, buf):
         buf.write_u8(value)
+def build_version() -> str:
+    """
+    Returns the version specified in the crate's Cargo.toml.
+"""
+    _uniffi_lowered_args = (
+    )
+    _uniffi_lift_return = _UniffiFfiConverterString.lift
+    _uniffi_error_converter = None
+    _uniffi_ffi_result = _uniffi_rust_call_with_error(
+        _uniffi_error_converter,
+        _UniffiLib.uniffi_livekit_uniffi_fn_func_build_version,
+        *_uniffi_lowered_args,
+    )
+    return _uniffi_lift_return(_uniffi_ffi_result)
 def generate_token(options: TokenOptions,credentials: typing.Optional[ApiCredentials]) -> str:
     """
     Generates an access token.
@@ -1984,6 +2007,7 @@ def verify_token(token: str,credentials: typing.Optional[ApiCredentials]) -> Cla
     "Claims",
     "LogForwardEntry",
     "TokenOptions",
+    "build_version",
     "generate_token",
     "log_forward_bootstrap",
     "log_forward_receive",

livekit-uniffi/generated/swift/livekit_uniffi.swift

@@ -1572,6 +1572,15 @@ fileprivate func uniffiFutureContinuationCallback(handle: UInt64, pollResult: In
         print("uniffiFutureContinuationCallback invalid handle")
     }
 }
+/**
+ * Returns the version specified in the crate's Cargo.toml.
+ */
+public func buildVersion() -> String  {
+    return try!  FfiConverterString.lift(try! rustCall() {
+    uniffi_livekit_uniffi_fn_func_build_version($0
+    )
+})
+}
 /**
  * Generates an access token.
  *
@@ -1656,6 +1665,9 @@ private let initializationResult: InitializationResult = {
     if bindings_contract_version != scaffolding_contract_version {
         return InitializationResult.contractVersionMismatch
     }
+    if (uniffi_livekit_uniffi_checksum_func_build_version() != 45072) {
+        return InitializationResult.apiChecksumMismatch
+    }
     if (uniffi_livekit_uniffi_checksum_func_generate_token() != 29823) {
         return InitializationResult.apiChecksumMismatch
     }

livekit-uniffi/generated/swift/livekit_uniffiFFI.h

@@ -242,6 +242,12 @@ typedef struct UniffiForeignFutureResultVoid {
 typedef void (*UniffiForeignFutureCompleteVoid)(uint64_t, UniffiForeignFutureResultVoid
     );
 
+#endif
+#ifndef UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_FN_FUNC_BUILD_VERSION
+#define UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_FN_FUNC_BUILD_VERSION
+RustBuffer uniffi_livekit_uniffi_fn_func_build_version(RustCallStatus *_Nonnull out_status
+    
+);
 #endif
 #ifndef UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_FN_FUNC_GENERATE_TOKEN
 #define UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_FN_FUNC_GENERATE_TOKEN
@@ -522,6 +528,12 @@ void ffi_livekit_uniffi_rust_future_free_void(uint64_t handle
 #ifndef UNIFFI_FFIDEF_FFI_LIVEKIT_UNIFFI_RUST_FUTURE_COMPLETE_VOID
 #define UNIFFI_FFIDEF_FFI_LIVEKIT_UNIFFI_RUST_FUTURE_COMPLETE_VOID
 void ffi_livekit_uniffi_rust_future_complete_void(uint64_t handle, RustCallStatus *_Nonnull out_status
+);
+#endif
+#ifndef UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_CHECKSUM_FUNC_BUILD_VERSION
+#define UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_CHECKSUM_FUNC_BUILD_VERSION
+uint16_t uniffi_livekit_uniffi_checksum_func_build_version(void
+    
 );
 #endif
 #ifndef UNIFFI_FFIDEF_UNIFFI_LIVEKIT_UNIFFI_CHECKSUM_FUNC_GENERATE_TOKEN

livekit-uniffi/python_test/main.py

@@ -10,6 +10,9 @@ def main():
     # Receive log messages from Rust
     log_forward_bootstrap(level=LogForwardFilter.INFO)
 
+    # Print FFI version
+    print(f"FFI version: v{build_version()}")
+
     credentials = ApiCredentials(key="devkey", secret="secret")
 
     jwt = generate_token(

livekit-uniffi/src/build_info.rs

@@ -0,0 +1,21 @@
+// Copyright 2025 LiveKit, Inc.
+//
+// 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
+//
+//     http://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.
+
+/// Returns the version specified in the crate's Cargo.toml.
+#[uniffi::export]
+pub fn build_version() -> String {
+    env!("CARGO_PKG_VERSION").to_string()
+}
+
+// TODO: consider adding other info such as timestamp and Git hash.

livekit-uniffi/src/lib.rs

@@ -18,6 +18,9 @@ pub mod access_token;
 /// Forward log messages from Rust.
 pub mod log_forward;
 
+/// Information about the build such as version.
+pub mod build_info;
+
 // TODO: expose more modules...
 
 uniffi::setup_scaffolding!();