Constant tsproto_structs::book::DATA_STR[][src]

pub const DATA_STR: &str = "[[struct]]\nname = \"ServerGroup\"\nid = [\n\t{ struct=\"ServerGroup\", prop=\"Id\" },\n]\ndoc = \"Get in notifyservergrouplist\"\nproperties = [\n\t{ name=\"Id\", type=\"ServerGroupId\" },\n\t{ name=\"Name\", type=\"str\" },\n\t{ name=\"GroupType\", type=\"GroupType\" },\n\t{ name=\"Icon\", type=\"IconId\" },\n\t{ name=\"IsPermanent\", type=\"bool\", doc=\"If the group is saved to the server database\" },\n\t{ name=\"SortId\", type=\"i32\" },\n\t{ name=\"NamingMode\", type=\"GroupNamingMode\" },\n\t{ name=\"NeededModifyPower\", type=\"i32\" },\n\t{ name=\"NeededMemberAddPower\", type=\"i32\" },\n\t{ name=\"NeededMemberRemovePower\", type=\"i32\", opt=true },\n]\n\n[[struct]]\nname = \"ChannelGroup\"\nid = [\n\t{ struct=\"ChannelGroup\", prop=\"Id\" },\n]\ndoc = \"Get in notifychannelgrouplist\"\nproperties = [\n\t{ name=\"Id\", type=\"ChannelGroupId\" },\n\t{ name=\"Name\", type=\"str\" },\n\t{ name=\"GroupType\", type=\"GroupType\" },\n\t{ name=\"Icon\", type=\"IconId\" },\n\t{ name=\"IsPermanent\", type=\"bool\", doc=\"If the group is saved to the server database\" },\n\t{ name=\"SortId\", type=\"i32\" },\n\t{ name=\"NamingMode\", type=\"GroupNamingMode\" },\n\t{ name=\"NeededModifyPower\", type=\"i32\" },\n\t{ name=\"NeededMemberAddPower\", type=\"i32\" },\n\t{ name=\"NeededMemberRemovePower\", type=\"i32\", opt=true },\n]\n\n[[struct]]\nname = \"OptionalChannelData\"\nopt = true\nid = [\n\t{ struct=\"Channel\", prop=\"Id\" },\n]\ndoc = \"Get in notifychanneledited by channelgetdescription\"\nproperties = [\n\t{ name=\"Description\", type=\"str\" },\n]\n\n[[struct]]\nname = \"Channel\"\nid = [\n\t{ struct=\"Channel\", prop=\"Id\" },\n]\ndoc = \"Get in channellist\"\nproperties = [\n\t{ name=\"Id\", type=\"ChannelId\" },\n\t{ name=\"Guid\", type=\"str\", opt=true },\n\t{ name=\"Parent\", type=\"ChannelId\", doc=\"0 means root channel\" },\n\t{ name=\"Name\", type=\"str\" },\n\t{ name=\"Topic\", type=\"str\", opt=true },\n\t{ name=\"Codec\", type=\"Codec\" },\n\t{ name=\"CodecQuality\", type=\"u8\", opt=true },\n\t{ name=\"MaxClients\", type=\"MaxClients\", opt=true, doc=\"The maximum number of clients in the channel.\" },\n\t{ name=\"MaxFamilyClients\", type=\"MaxClients\", opt=true, doc=\"Maximum number of clients in this and all child channels.\" },\n\t{ name=\"Order\", type=\"ChannelId\", doc=\"The preceding channel id.\" },\n\t{ name=\"ChannelType\", type=\"ChannelType\" },\n\t{ name=\"IsDefault\", type=\"bool\", opt=true, doc=\"Whether it is the default channel\" },\n\t{ name=\"HasPassword\", type=\"bool\", opt=true, doc=\"Whether this channel has a password\" },\n\t{ name=\"CodecLatencyFactor\", type=\"i32\", opt=true, doc=\"TODO Type?\" },\n\t{ name=\"IsUnencrypted\", type=\"bool\", opt=true },\n\t{ name=\"DeleteDelay\", type=\"Duration\", opt=true },\n\t{ name=\"NeededTalkPower\", type=\"i32\", opt=true },\n\t{ name=\"ForcedSilence\", type=\"bool\" },\n\t{ name=\"PhoneticName\", type=\"str\", opt=true },\n\t{ name=\"Icon\", type=\"IconId\", opt=true },\n\t{ name=\"IsPrivate\", type=\"bool\", opt=true },\n\t{ name=\"Subscribed\", type=\"bool\" },\n\t{ name=\"PermissionHints\", type=\"ChannelPermissionHint\", opt=true },\n\t{ name=\"OptionalData\", type=\"OptionalChannelData\", opt=true },\n]\n\n[[struct]]\nname = \"OptionalClientData\"\nopt = true\nid = [\n\t{ struct=\"Client\", prop=\"Id\" },\n]\ndoc = \"Get in notifyclientupdated by clientgetvariables\"\nproperties = [\n\t{ name=\"Version\", type=\"str\" },\n\t{ name=\"VersionSign\", type=\"str\", opt=true },\n\t{ name=\"Platform\", type=\"str\" },\n\t{ name=\"LoginName\", type=\"str\", opt=true, doc=\"Set only for server queries\" },\n\t{ name=\"Created\", type=\"DateTime\" },\n\t{ name=\"LastConnected\", type=\"DateTime\" },\n\t{ name=\"ConnectionsTotal\", type=\"u32\" },\n\t{ name=\"BytesUploadedMonth\", type=\"u64\" },\n\t{ name=\"BytesDownloadedMonth\", type=\"u64\" },\n\t{ name=\"BytesUploadedTotal\", type=\"u64\" },\n\t{ name=\"BytesDownloadedTotal\", type=\"u64\" },\n]\n\n[[struct]]\nname = \"ConnectionClientData\"\nopt = true\nid = [\n\t{ struct=\"Client\", prop=\"Id\" },\n]\ndoc = \"Get in notifyconnectioninfo by getconnectioninfo\"\nproperties = [\n\t{ name=\"Ping\", type=\"Duration\", opt=true },\n\t{ name=\"PingDeviation\", type=\"Duration\", opt=true },\n\t{ name=\"ConnectedTime\", type=\"Duration\", opt=true },\n\t{ name=\"ClientAddress\", type=\"SocketAddr\", opt=true, doc=\"Only available if we have the permission to view it\" },\n\t{ name=\"PacketsSentSpeech\", type=\"u64\", opt=true },\n\t{ name=\"PacketsSentKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"PacketsSentControl\", type=\"u64\", opt=true },\n\t{ name=\"BytesSentSpeech\", type=\"u64\", opt=true },\n\t{ name=\"BytesSentKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"BytesSentControl\", type=\"u64\", opt=true },\n\t{ name=\"PacketsReceivedSpeech\", type=\"u64\", opt=true },\n\t{ name=\"PacketsReceivedKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"PacketsReceivedControl\", type=\"u64\", opt=true },\n\t{ name=\"BytesReceivedSpeech\", type=\"u64\", opt=true },\n\t{ name=\"BytesReceivedKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"BytesReceivedControl\", type=\"u64\", opt=true },\n\t{ name=\"ServerToClientPacketlossSpeech\", type=\"f32\", opt=true },\n\t{ name=\"ServerToClientPacketlossKeepalive\", type=\"f32\", opt=true },\n\t{ name=\"ServerToClientPacketlossControl\", type=\"f32\", opt=true },\n\t{ name=\"ServerToClientPacketlossTotal\", type=\"f32\", opt=true },\n\t{ name=\"ClientToServerPacketlossSpeech\", type=\"f32\" },\n\t{ name=\"ClientToServerPacketlossKeepalive\", type=\"f32\" },\n\t{ name=\"ClientToServerPacketlossControl\", type=\"f32\" },\n\t{ name=\"ClientToServerPacketlossTotal\", type=\"f32\" },\n\t{ name=\"BandwidthSentLastSecondSpeech\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthSentLastSecondKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthSentLastSecondControl\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthSentLastMinuteSpeech\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthSentLastMinuteKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthSentLastMinuteControl\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthReceivedLastSecondSpeech\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthReceivedLastSecondKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthReceivedLastSecondControl\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthReceivedLastMinuteSpeech\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthReceivedLastMinuteKeepalive\", type=\"u64\", opt=true },\n\t{ name=\"BandwidthReceivedLastMinuteControl\", type=\"u64\", opt=true },\n\t{ name=\"FiletransferBandwidthSent\", type=\"u64\", opt=true },\n\t{ name=\"FiletransferBandwidthReceived\", type=\"u64\", opt=true },\n\t{ name=\"IdleTime\", type=\"Duration\" },\n]\n\n[[struct]]\nname = \"Client\"\nid = [\n\t{ struct=\"Client\", prop=\"Id\" },\n]\ndoc = \"Get in notifycliententerview\"\nproperties = [\n\t{ name=\"Id\", type=\"ClientId\" },\n\t{ name=\"Channel\", type=\"ChannelId\" },\n\t{ name=\"Uid\", type=\"Uid\", opt=true, doc=\"Unique Identifier\" },\n\t{ name=\"Name\", type=\"str\" },\n\t{ name=\"InputMuted\", type=\"bool\", doc=\"`true` if muted, `false` otherwise\" },\n\t{ name=\"OutputMuted\", type=\"bool\", doc=\"`true` if muted, `false` otherwise\" },\n\t{ name=\"OutputOnlyMuted\", type=\"bool\", doc=\"`true` if muted, `false` otherwise\" },\n\t{ name=\"InputHardwareEnabled\", type=\"bool\", doc=\"`true` if enabled, `false` if disabled\" },\n\t{ name=\"OutputHardwareEnabled\", type=\"bool\", doc=\"`true` if enabled, `false` if disabled\" },\n\t{ name=\"TalkPowerGranted\", type=\"bool\", doc=\"If the client is granted talk power\" },\n\t{ name=\"Metadata\", type=\"str\", doc=\"Set by client\" },\n\t{ name=\"IsRecording\", type=\"bool\", doc=\"Whether the client is recording\" },\n\t{ name=\"DatabaseId\", type=\"ClientDbId\" },\n\t{ name=\"ChannelGroup\", type=\"ChannelGroupId\" },\n\t{ name=\"ServerGroups\", type=\"ServerGroupId\", mod=\"set\" },\n\t{ name=\"AwayMessage\", type=\"str\", opt=true, doc=\"Contains the away message if the client is away\" },\n\t{ name=\"ClientType\", type=\"ClientType\", doc=\"If this client is a server query or not\" },\n\t{ name=\"AvatarHash\", type=\"str\", doc=\"MD5 hash of the avatar, used to retrieve the avatar\" },\n\t{ name=\"TalkPower\", type=\"i32\" },\n\t{ name=\"TalkPowerRequest\", type=\"TalkPowerRequest\", opt=true, doc=\"Contains a message and timestamp from the client if he requests talk power\" },\n\t{ name=\"Description\", type=\"str\" },\n\t{ name=\"IsPrioritySpeaker\", type=\"bool\" },\n\t{ name=\"UnreadMessages\", type=\"u32\" },\n\t{ name=\"PhoneticName\", type=\"str\" },\n\t{ name=\"NeededServerqueryViewPower\", type=\"i32\" },\n\t{ name=\"Icon\", type=\"IconId\" },\n\t{ name=\"IsChannelCommander\", type=\"bool\" },\n\t{ name=\"CountryCode\", type=\"str\", doc=\"Like US, DE\" },\n\t{ name=\"InheritedChannelGroupFromChannel\", type=\"ChannelId\" },\n\t{ name=\"Badges\", type=\"str\" },\n\t{ name=\"PermissionHints\", type=\"ClientPermissionHint\", opt=true },\n\t{ name=\"OptionalData\", type=\"OptionalClientData\", opt=true },\n\t{ name=\"ConnectionData\", type=\"ConnectionClientData\", opt=true },\n]\n\n[[struct]]\nname = \"OptionalServerData\"\nopt = true\nid = [\n]\ndoc = \"Get by notifyserverupdated after requested by servergetvariables\"\nproperties = [\n\t{ name=\"Uptime\", type=\"Duration\" },\n\t{ name=\"HasPassword\", type=\"bool\" },\n\t{ name=\"DefaultChannelAdminGroup\", type=\"ChannelGroupId\", doc=\"The channel group which will be given to channel creators\" },\n\t{ name=\"MaxDownloadBandwidthTotal\", type=\"u64\" },\n\t{ name=\"MaxUploadBandwidthTotal\", type=\"u64\" },\n\t{ name=\"ComplainAutobanCount\", type=\"u32\" },\n\t{ name=\"ComplainAutobanTime\", type=\"Duration\" },\n\t{ name=\"ComplainRemoveTime\", type=\"Duration\" },\n\t{ name=\"MinClientsInChannelBeforeForcedSilence\", type=\"u16\", doc=\"How many clients can be in a server before silence is forced\" },\n\t{ name=\"AntifloodPointsTickReduce\", type=\"u32\" },\n\t{ name=\"AntifloodPointsToCommandBlock\", type=\"u32\" },\n\t{ name=\"AntifloodPointsToIpBlock\", type=\"u32\" },\n\t{ name=\"AntifloodPointsToPluginBlock\", type=\"u32\" },\n\t{ name=\"ConnectionCountTotal\", type=\"u64\", doc=\"The amount of connections on this server.\\n\\nThis includes normal clients and server queries.\" },\n\t{ name=\"ChannelCount\", type=\"u64\", doc=\"The amount of channels on the server\" },\n\t{ name=\"ClientCount\", type=\"u16\", doc=\"The amount of clients which are online on the server\" },\n\t{ name=\"QueryCountTotal\", type=\"u64\", doc=\"Amount of server queries connected to the server\" },\n\t{ name=\"QueryCount\", type=\"u32\", doc=\"Amount of server queries connected and online/visible on the server\" },\n\t{ name=\"DownloadQuota\", type=\"u64\" },\n\t{ name=\"UploadQuota\", type=\"u64\" },\n\t{ name=\"BytesDownloadedMonth\", type=\"u64\" },\n\t{ name=\"BytesUploadedMonth\", type=\"u64\" },\n\t{ name=\"BytesDownloadedTotal\", type=\"u64\" },\n\t{ name=\"BytesUploadedTotal\", type=\"u64\" },\n\t{ name=\"Port\", type=\"u16\" },\n\t{ name=\"Autostart\", type=\"bool\" },\n\t{ name=\"MachineId\", type=\"str\" },\n\t{ name=\"NeededIdentitySecurityLevel\", type=\"u8\" },\n\t{ name=\"LogClient\", type=\"bool\" },\n\t{ name=\"LogQuery\", type=\"bool\" },\n\t{ name=\"LogChannel\", type=\"bool\" },\n\t{ name=\"LogPermissions\", type=\"bool\" },\n\t{ name=\"LogServer\", type=\"bool\" },\n\t{ name=\"LogFiletransfer\", type=\"bool\" },\n\t{ name=\"MinClientVersion\", type=\"DateTime\" },\n\t{ name=\"ReservedSlots\", type=\"u16\" },\n\t{ name=\"TotalPacketlossSpeech\", type=\"f32\" },\n\t{ name=\"TotalPacketlossKeepalive\", type=\"f32\" },\n\t{ name=\"TotalPacketlossControl\", type=\"f32\" },\n\t{ name=\"TotalPacketloss\", type=\"f32\" },\n\t{ name=\"TotalPing\", type=\"Duration\" },\n\t{ name=\"WeblistEnabled\", type=\"bool\" },\n\t{ name=\"MinAndroidVersion\", type=\"DateTime\", doc=\"TODO Maybe str\" },\n\t{ name=\"MinIosVersion\", type=\"DateTime\" },\n]\n\n[[struct]]\nname = \"ConnectionServerData\"\nopt = true\nid = [\n]\ndoc = \"Get by notifyserverconnectioninfo after serverrequestconnectioninfo\"\nproperties = [\n\t{ name=\"FiletransferBandwidthSent\", type=\"u64\" },\n\t{ name=\"FiletransferBandwidthReceived\", type=\"u64\" },\n\t{ name=\"FiletransferBytesSentTotal\", type=\"u64\" },\n\t{ name=\"FiletransferBytesReceivedTotal\", type=\"u64\" },\n\t{ name=\"PacketsSentTotal\", type=\"u64\" },\n\t{ name=\"BytesSentTotal\", type=\"u64\" },\n\t{ name=\"PacketsReceivedTotal\", type=\"u64\" },\n\t{ name=\"BytesReceivedTotal\", type=\"u64\" },\n\t{ name=\"BandwidthSentLastSecondTotal\", type=\"u64\" },\n\t{ name=\"BandwidthSentLastMinuteTotal\", type=\"u64\" },\n\t{ name=\"BandwidthReceivedLastSecondTotal\", type=\"u64\" },\n\t{ name=\"BandwidthReceivedLastMinuteTotal\", type=\"u64\" },\n\t{ name=\"ConnectedTime\", type=\"Duration\" },\n\t{ name=\"PacketlossTotal\", type=\"f32\" },\n\t{ name=\"Ping\", type=\"Duration\" },\n]\n\n[[struct]]\nname = \"Server\"\nid = [\n]\ndoc = \"Get in initserver\"\nproperties = [\n\t{ name=\"PublicKey\", type=\"EccKeyPubP256\" },\n\t{ name=\"Id\", type=\"u64\", doc=\"The virtual server id\" },\n\t# `Uid` is generated from public key\n\t{ name=\"Name\", type=\"str\" },\n\t{ name=\"Nickname\", type=\"str\", opt=true },\n\t{ name=\"WelcomeMessage\", type=\"str\", doc=\"Welcome message when conecting to a server\" },\n\t{ name=\"Platform\", type=\"str\" },\n\t{ name=\"Version\", type=\"str\" },\n\t{ name=\"MaxClients\", type=\"u16\", doc=\"The maximum number of clients on the server\" },\n\t{ name=\"Created\", type=\"DateTime\", doc=\"Seems to be always 0\" },\n\t{ name=\"CodecEncryptionMode\", type=\"CodecEncryptionMode\" },\n\t{ name=\"Hostmessage\", type=\"str\" },\n\t{ name=\"HostmessageMode\", type=\"HostMessageMode\" },\n\t{ name=\"DefaultServerGroup\", type=\"ServerGroupId\" },\n\t{ name=\"DefaultChannelGroup\", type=\"ChannelGroupId\" },\n\t{ name=\"HostbannerUrl\", type=\"str\" },\n\t{ name=\"HostbannerGfxUrl\", type=\"str\" },\n\t{ name=\"HostbannerGfxInterval\", type=\"Duration\", doc=\"How often the hostbanner should be updated\" },\n\t{ name=\"PrioritySpeakerDimmModificator\", type=\"f32\" },\n\t{ name=\"HostbuttonTooltip\", type=\"str\" },\n\t{ name=\"HostbuttonUrl\", type=\"str\" },\n\t{ name=\"HostbuttonGfxUrl\", type=\"str\" },\n\t{ name=\"PhoneticName\", type=\"str\" },\n\t{ name=\"Icon\", type=\"IconId\", doc=\"Should be an u32, sometimes the server sends an u64 or an i32 for reasons which has to be cut to 32 bit\" },\n\t{ name=\"Ips\", type=\"IpAddr\", mod=\"array\", doc=\"A list of listen ips, can be empty\" },\n\t{ name=\"AskForPrivilegekey\", type=\"bool\" },\n\t{ name=\"HostbannerMode\", type=\"HostBannerMode\" },\n\t{ name=\"TempChannelDefaultDeleteDelay\", type=\"Duration\" },\n\t{ name=\"ProtocolVersion\", type=\"u16\" },\n\t{ name=\"License\", type=\"LicenseType\" },\n\t{ name=\"OptionalData\", type=\"OptionalServerData\", opt=true },\n\t{ name=\"ConnectionData\", type=\"ConnectionServerData\", opt=true },\n]\n\n[[struct]]\nname = \"Connection\"\nid = [\n]\ndoc = \"A connection from our client to a server\"\nproperties = [\n\t{ name=\"OwnClient\", type=\"ClientId\", doc=\"The id of our own client on the server\" },\n\t{ name=\"Server\", type=\"Server\", doc=\"The server of this connection\" },\n\t{ name=\"Clients\", type=\"Client\", mod=\"map\", key=\"ClientId\", doc=\"All clients which are visible for us\" },\n\t{ name=\"Channels\", type=\"Channel\", mod=\"map\", key=\"ChannelId\", doc=\"All channels on the server\" },\n\t{ name=\"ServerGroups\", type=\"ServerGroup\", mod=\"map\", key=\"ServerGroupId\", doc=\"All server groups on the server\" },\n\t{ name=\"ChannelGroups\", type=\"ChannelGroup\", mod=\"map\", key=\"ChannelGroupId\", doc=\"All channel groups on the server\" },\n]\n";