rime.nvim

• Index

Contents

• Functions
• user/site directories
• user directories

Modules

• rime.key
• rime.nvim
• rime.nvim.plugins.cmp
• rime.nvim.rime
• rime.rime
• rime.session
• rime.traits
• ime
• ime.fn
• ime.ime
• ime.key
• ime.nvim.hooks.airline
• ime.nvim.hooks.chainedhook
• ime.nvim.hooks.cursor
• ime.nvim.keymap
• ime.nvim.win
• ime.ui
• platformdirs
• platformdirs.platforms
• platformdirs.platforms.android
• platformdirs.platforms.macos
• platformdirs.platforms.unix
• platformdirs.platforms.windows

Topics

• README

Module platformdirs.platforms

abstract class.

Functions

M.PlatformDirs:new (platformdirs)
M.PlatformDirs:append_app_name_and_version (...)
M.PlatformDirs:first_item_as_path_if_multipath (directory)
M.PlatformDirs.get_home ()
M.PlatformDirs:expand_user (path)

user/site directories

M.PlatformDirs:user_data_dir ()	store user-specific data files.
M.PlatformDirs:site_data_dir ()	the preference-ordered set of base directories to search for data files.
M.PlatformDirs:site_data_dirs ()
M.PlatformDirs:user_config_dir ()	store user-specific configuration files.
M.PlatformDirs:site_config_dir ()	the preference-ordered set of base directories to search for configuration files.
M.PlatformDirs:site_config_dirs ()
M.PlatformDirs:user_cache_dir ()	store user-specific non-essential files.
M.PlatformDirs:site_cache_dir ()	user_cache_dir
M.PlatformDirs:user_state_dir ()	store user-specific state files.
M.PlatformDirs:user_log_dir ()	user_state_dir/log
M.PlatformDirs:user_runtime_dir ()	store user-specific non-essential runtime files and other file objects such as sockets, named pipes, ...
M.PlatformDirs:site_runtime_dir ()	user_runtime_dir

user directories

M.PlatformDirs:user_documents_dir ()	~
M.PlatformDirs:user_downloads_dir ()	~
M.PlatformDirs:user_pictures_dir ()	~
M.PlatformDirs:user_videos_dir ()	~
M.PlatformDirs:user_music_dir ()	~
M.PlatformDirs:user_desktop_dir ()	~

Functions

M.PlatformDirs:new (platformdirs)

Parameters:

• platformdirs table?

Returns:

table platformdirs

M.PlatformDirs:append_app_name_and_version (...)

Parameters:

• ... string

Returns:

string

M.PlatformDirs:first_item_as_path_if_multipath (directory)

Parameters:

• directory string

Returns:

string

M.PlatformDirs.get_home ()

Returns:

string

M.PlatformDirs:expand_user (path)

Parameters:

• path string

Returns:

string

user/site directories

M.PlatformDirs:user_data_dir ()

store user-specific data files. ~/.$app

Returns:

string

M.PlatformDirs:site_data_dir ()

the preference-ordered set of base directories to search for data files. user_data_dir

Returns:

string

M.PlatformDirs:site_data_dirs ()

Returns:

string[]

M.PlatformDirs:user_config_dir ()

store user-specific configuration files. user_data_dir

Returns:

string

M.PlatformDirs:site_config_dir ()

the preference-ordered set of base directories to search for configuration files. user_config_dir

Returns:

string

M.PlatformDirs:site_config_dirs ()

Returns:

string[]

M.PlatformDirs:user_cache_dir ()

store user-specific non-essential files. user_data_dir

Returns:

string

M.PlatformDirs:site_cache_dir ()

user_cache_dir

Returns:

string

M.PlatformDirs:user_state_dir ()

store user-specific state files. user_cache_dir

Returns:

string

M.PlatformDirs:user_log_dir ()

user_state_dir/log

Returns:

string

M.PlatformDirs:user_runtime_dir ()

store user-specific non-essential runtime files and other file objects such as sockets, named pipes, ... user_cache_dir/tmp

Returns:

string

M.PlatformDirs:site_runtime_dir ()

user_runtime_dir

Returns:

string

user directories

M.PlatformDirs:user_documents_dir ()

~

Returns:

string

M.PlatformDirs:user_downloads_dir ()

~

Returns:

string

M.PlatformDirs:user_pictures_dir ()

~

Returns:

string

M.PlatformDirs:user_videos_dir ()

~

Returns:

string

M.PlatformDirs:user_music_dir ()

~

Returns:

string

M.PlatformDirs:user_desktop_dir ()

~

Returns:

string