From 922efea6a7c417bf9e6356726283d5f1c2f4f773 Mon Sep 17 00:00:00 2001 From: Felix Prillwitz Date: Thu, 23 Jan 2025 21:33:56 +0100 Subject: [PATCH] hide and improve docs of uid --- connect/src/model.rs | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/connect/src/model.rs b/connect/src/model.rs index c324c36df..5e15b01ac 100644 --- a/connect/src/model.rs +++ b/connect/src/model.rs @@ -95,10 +95,17 @@ pub enum PlayingTrack { Index(u32), /// Represent the uri of a track. Uri(String), + #[doc(hidden)] /// Represent an internal identifier from spotify. /// - /// ## Remarks: - /// Is not intended for usage, but required for parsing of some connect messages. + /// The internal identifier is not the id contained in the uri. And rather + /// an unrelated id probably unique in spotify's internal database. But that's + /// just speculation. + /// + /// This identifier is not available by any public api. It's used for varies in + /// any spotify client, like sorting, displaying which track is currently played + /// and skipping to a track. Mobile uses it pretty intensively but also web and + /// desktop seem to make use of it. Uid(String), }